Added versioning to init.py and setup.py using the manual approach. #20
Conversation
| @@ -0,0 +1 @@ | |||
| __version__ = "0.2.1-dev" | |||
There was a problem hiding this comment.
Usually "0.y.z" already states "dev" no?
There was a problem hiding this comment.
I am not an expert on this: this "dev" means that is the development version after the tagging of the last release (the docs will be built from the master branch as for ctapipe, which code to get the version is a bit complicated for me now.).
I have seen people using "-alpha", "-beta", but I didn't want to be overly specific for the moment.
There was a problem hiding this comment.
I think in this case, "dev" means "not a tagged release"
setup.py
Outdated
| setup( | ||
| name="protopipe", | ||
| version="0.2.1-dev", |
There was a problem hiding this comment.
Error-prone when the version changes and you have several places to update.
You might prefer to read the version directly:
import protopipe
setup(
name="protopipe",
version=protopipe.__version__
There was a problem hiding this comment.
Is it costumary to import the package in here?
Like import protopipe and then protopipe.__version__?
There was a problem hiding this comment.
There are several ways to do it and I am not sure there is really one customary way.
You may also use
from pkg_resources import get_distribution
get_distribution('protopipe').version
There was a problem hiding this comment.
This way I would need to add a new dependence.
Doing from protopipe._version import __version__ should work nicely for the moment and I can do the same later in docs/conf.py.
There was a problem hiding this comment.
Then why not importing protopipe as suggested first?
It is customary to have the version in __init__.py.
There was a problem hiding this comment.
Yes, in the end, is the same, __version__ gets imported from __init__.py
setup.py
Outdated
| description="Pipeline to process events from DL0 to DL3", | ||
| url="https://github.com/cta-observatory/protopipe", | ||
| author="CEA", |
There was a problem hiding this comment.
cta-observatory?
Or authors read directly from GitHub.
There was a problem hiding this comment.
Yes, I forgot to update the authors: I can update the list from GitHub - is there an automatic way? I can do it as in ctapipe but later; fast solution would be to copy paste the list from the CHANGELOG
| @@ -0,0 +1 @@ | |||
| __version__ = "0.2.1-dev" | |||
There was a problem hiding this comment.
I think in this case, "dev" means "not a tagged release"
|
I guess you could also call it "0.2.2-alpha" or something like that (e.g. the alpha version of the next release). No preference for me, as long as it's updated (obviously) when you do the actual release. @vuillaut this is just so that if somebody installs the master version using pip, you can tell it's not a release version. |
Yes, I guess alpha would be anyway a more correct naming. |
Versioning in the documentation will be added after this PR has been merged.