-
Notifications
You must be signed in to change notification settings - Fork 103
Stable tagged release? #28
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
Comments
My apologies. I probably should have submitted tagged releases with deprecation warnings, etc., but (1) I didn't like the idea of "releasing ProPlot to the world" without setting up CI testing, and (2) I didn't want to document versions of ProPlot before the new "panels" API is complete (see below), since it's such a big change. Rest assured after the panels API is finished, the next priority will be CI testing and the version 1.0 release -- I've had your Just to give an explanation for the two big changes you've noticed:
|
No worries! Didn't mean to come off harsh there. I love the package and want to keep using it so keeping a stable version installed will help me to flow with it. I noticed the panels change, and after I went through the docs, it's a nice logical change. I can tell you CI is going to take a long time to set up with regards to decent coverage on testing. I would help with the testing but am getting pulled in too many directions with my work right now. But you could probably cover a lot of your modules just by having testing to generate various configurations of panels, plots, etc. Looping through map projections and so on (see Here's our testing suite at A barebones test at my personal package The most helpful thing you could do for users is to maintain a changelog with your updates: https://github.com/bradyrx/climpred/blob/master/CHANGELOG.rst. Then we can just jump right there with the new releases and see that the panels API changed and so on. That of course would require you to have contained Pull Requests :) As always, feel free to email/text if you have questions about the CI stuff. Once you get into the flow I'm sure it'll be smooth sailing for you. |
I am now thinking I will release a version 0.1 after #47 is merged but before the two major refactoring PRs are merged (#50 and #45). I'll consider the 0.X releases "beta" versions (there might just be one or two), then when those PRs are merged, I will jump up to 1.0 and go from there. This project is getting more stars every week which is cool but kind of scary. It's definitely time for people to be able to download individual stable versions. After this you will also be able to contribute directly if you feel so inclined :). It looks like matplotlib has an image comparison utility that they use for their tests, so that might be a starting point for failures that are "visual/subjective" in nature. I suppose I'll add tests incrementally within the version 0.X releases. |
Closed by 9280232. See the new README and the pypi page. Documentation is not up because of an RTD memory issue, but once they respond to readthedocs/readthedocs.org#6412 it will have pages with contribution instructions, release instructions, etc. like xarray and climpred. |
readthedocs doesn't give you much memory at all to build. I had memory crashes just by having @xylar had the same issue at MPAS-Analysis (MPAS-Dev/MPAS-Analysis#652) and opted to just host their docs on github pages, which is another option. Here's their Travis code to build and publish the docs: https://github.com/MPAS-Dev/MPAS-Analysis/blob/develop/ci/test_and_publish_docs.bash Note that as I mentioned in another PR or issue, you can get RTD to build on your PRs now with a simple email. Then you'll be able to catch before merging if they break like this. |
That's too bad. Not sure if you're aware of nbstripout but you could use this in your travis build instructions. I currently use nbstripout as a gitattributes filter so that cell output is never committed (see HOWTOCONTRIBUTE (which was mostly copied from yours), .gitattributes, and .gitconfig). This massively reduces the repo size. This guy on stackoverflow has another interesting approach. I kind of prefer keeping things on readthedocs because it lends the project more credibility... a readthedocs URL seems more "official" than some random dude's First step I think will be to formally request more memory. They have instructions to do so here. I have pretty good reason to need more memory since it's a plotting package. If that fails may try that stackoverflow approach... I like the idea of putting figures in a submodule because that keeps the core repo size small. I emailed them to opt-in to RTD integration, just waiting on a response. When that happens (assuming they increase my memory) I guess I'll remove the |
Decided to set up pre-commits and add flake8 to travis today... pre-commit is pretty darn awesome, thanks for pointing it out. My code is also now pep8-compliant; |
But doesn't this in turn wipe out all the output of the cells? Most of my notebooks have meaningful cell output (e.g. xarray dataset printouts, figures) that I want on my docs. So I need to keep the cells executed if I am not having
Keep me posted here on what happens. Particularly if they respond well to a memory increase. I don't fully understand what they're doing on the stack exchange example, and I currently like at least that things are all handled through Travis and RTD PR beta addon.
Awesome. This is a huge help overall for development. |
Right so FYI when you use ...or I guess you can just set |
@bradyrx It's fixed: Check out the new docs and see readthedocs/readthedocs.org#6412. I opted for a longer sidebar with shorter individual sections. Make sure to try out the Light / Dark mode toggle at the top of the page! They approved the increased memory for the |
Those docs look really awesome @lukelbd. Great job! I think this cleans it up a lot and makes it easier to find what you need. I also dig the dark mode.. will have to look into how you did that. Thanks for the tips on |
Np, thanks! And just realized setting The docs modifications are in custom.css, custom.js, layout.html, and breadcrumbs.html. For the dark-light mode stuff I followed this guide. My conf.py also auto-generates pygments style files so the dark-light mode toggle can choose between them rather than leaving this to RTD internals. Might ask you to tweak the colors your own way for climpred because I kind of like having a unique style for ProPlot. |
It would be great if you could make a tagged version release on pip that's stable. The API changes so frequently right now that I feel like I'm rewriting my notebook cells every week when I pull down updates. Then folks could just install a specific version from pip while you continue development.
Releasing on PyPI takes < 5 minutes: https://github.com/bradyrx/climpred/blob/master/HOWTORELEASE.rst. You could tag a v1.0.0 and then follow semantic versioning (https://semver.org/) as you release more features.
The text was updated successfully, but these errors were encountered: