Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide a setup.py and upload to PyPI.org #5

Open
BjoernLudwigPTB opened this issue Jan 28, 2021 · 2 comments
Open

Provide a setup.py and upload to PyPI.org #5

BjoernLudwigPTB opened this issue Jan 28, 2021 · 2 comments

Comments

@BjoernLudwigPTB
Copy link
Member

BjoernLudwigPTB commented Jan 28, 2021

In some of our applications we desire to include datareceiver als a proper dependency. We would like to add a extra_requires section in agentMET4FOF's setup.py to be able to straightaway use datareceiver with the agents by doing pip install agentMET4FOF[datareceiver] or something similar. Since PyPI.org will not allow installing dependencies for a package, that only exist on GitHub or similar, we need to publish datareceiver properly to make that possible. We would really appreciate that. If nobody has objections we would propose a setup.py and setup a CircleCI pipeline to publish the datareceiver as it is on the master branch. Then we could as well add a Zenodo release with DOI creation later...

The main questions related to that would be:

  • Which parts of the repository should be included in the PyPI.org release?
  • How do we minimally test datareceiver, to make sure the release is working as expected? Can we for example run it somehow and check for expected output?
    One possible way would be to follow the steps in the README for a simulated sensor based on the Zenodo dataset and check for the first lines of the mentioned console output.
@BjoernLudwigPTB BjoernLudwigPTB changed the title Provide a setup.py and upload to pypi.org Provide a setup.py and upload to PyPI.org Jan 28, 2021
@BeSeeTek
Copy link
Member

BeSeeTek commented May 7, 2021

hello björn
we should talk about this topic in the neare future since i will implement some last fixes in the actual datareceiver part and will consider it stable afterwards.

@BjoernLudwigPTB
Copy link
Member Author

hello björn
we should talk about this topic in the neare future since i will implement some last fixes in the actual datareceiver part and will consider it stable afterwards.

Let me know, as soon as you are ready. We can then discuss my questions from the original post in this issue and maybe more from your side.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants