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

Version information #12

Closed
kynan opened this issue Feb 15, 2016 · 9 comments
Closed

Version information #12

kynan opened this issue Feb 15, 2016 · 9 comments

Comments

@kynan
Copy link
Owner

kynan commented Feb 15, 2016

We currently only store the version in setup.py, which is not very useful. There should be a switch nbstripout --version and/or nbstripout version.

Options for implementing this include:

Any thoughts @mforbes @michaelaye?

@mforbes
Copy link
Contributor

mforbes commented Feb 15, 2016

I still don't have a definitive answer for how to do this. Another option is to include a variable __version__ (name as per PEP8 at the top of the nbstripout.py file and then read this in, or just manually change both that and the contents in setup.py.

@michaelaye
Copy link
Contributor

The python packaging guide offers 7 methods for doing this, just pick the one that you think fits best to your project:
https://python-packaging-user-guide.readthedocs.org/en/latest/single_source_version/

@michaelaye
Copy link
Contributor

but bumpversion and versioneer are certainly worth a look as well, depending on how easy they are to setup.

@mforbes
Copy link
Contributor

mforbes commented Feb 15, 2016

I tried bumpversion once, but found it not intunitive enough to use naturally when I only used it sporadically, so I stopped. That was a while ago - it might be better now. The idea is nice.

@michaelaye
Copy link
Contributor

I had a quick look at versioneer, sounds easy enough to use after a few clear installation steps.

@kynan
Copy link
Owner Author

kynan commented Feb 15, 2016

I have used versioneer in the past. It is quite "heavy" though, so I'm not sure it's worth the hassle for such a simple project.

@kynan
Copy link
Owner Author

kynan commented Feb 15, 2016

@michaelaye Thanks for pointing out the various options. For something as simple as nbstripout maybe bumpversion is enough. I'll give it a go.

@kynan
Copy link
Owner Author

kynan commented Feb 15, 2016

OK, reasonably happy with bumpversion from a quick test apart from missing support annotated tags: peritus/bumpversion#2, peritus/bumpversion#58, peritus/bumpversion#74.

@kynan kynan closed this as completed in e93e79e Feb 15, 2016
@kynan
Copy link
Owner Author

kynan commented Feb 15, 2016

Since I'm impatient I simply installed the bumpversion branch pr'ed in peritus/bumpversion#58:

pip install git+https://github.com/ekohl/bumpversion@annotated-tags

@kynan kynan self-assigned this Feb 15, 2016
ooiM added a commit to ooiM/nbstripout that referenced this issue Jun 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants