diff --git a/Deployment.md b/Deployment.md index 3530221..828d79f 100644 --- a/Deployment.md +++ b/Deployment.md @@ -4,17 +4,14 @@ These are instructions for releasing a new version of PyWEED to [conda-forge](ht Some helpful links: -* -* -* +- +- +- -__Do all this work in a Python 3 environment!__ Otherwise various flags (omitted here) are required. - -Some additional conda packages are required: +Some additional packages are required: ``` -conda install conda-build -conda install twine +conda install build conda-build twine ``` ## 1. Update the version @@ -30,26 +27,26 @@ scheme. From the top-level path in the project: ``` -python setup.py sdist +python -m build ``` -This will create a versioned distribution in the `dist/` subdirectory, ie. `dist/pyweed-0.5.5.tar.gz`. +This will create versioned products in the `dist/` subdirectory, ie. `dist/pyweed-1.0.9.tar.gz`. Upload to PyPi with: ``` -twine upload dist/pyweed-0.5.5.tar.gz +twine upload dist/* ``` You should see the new version listed on the PyPi page: -Find the download page for the new version; this should have a __sha256__ value which you will need for the next step. +Find the download page for the new version; this should have a **sha256** value which you will need for the next step. ## 3. Create an updated conda build recipe The official instructions are here: -NOTE: __This step can take a day or more__, since it has to go through the conda-forge automated builder. It can +NOTE: **This step can take a day or more**, since it has to go through the conda-forge automated builder. It can also get held up if the conda-forge linter doesn't like something about your changes. Plan accordingly! ### Update the build recipe @@ -63,13 +60,14 @@ The version is defined at the top of the `meta.yaml` file: ``` {% set name = "pyweed" %} -{% set version = "0.5.2.dev0" %} -{% set sha256 = "3e1e8e35cba3f09a52a540b4351042d9e62a98bc430d7f70315df621fb2177f1" %} +{% set version = "1.0.9" %} +{% set build_number = 0 %} +{% set sha256 = "6cadc138306134085ef09a979bb788179627b4dfb1dbbd401756076f1db3949d" %} ``` {% endraw %} -Change __version__ to match the new version number, and -update the __sha256__ value with the value from the PyPi page in the previous step. +Change **version** to match the new version number, and +update the **sha256** value with the value from the PyPi page in the previous step. ### Test Build @@ -83,16 +81,6 @@ For example, to build from `recipe/meta.yaml` you would say: conda build -c conda-forge recipe ``` -If you get a message like: - -``` -Skipped: /workspace/test/staged-recipes/recipes/pyweed defines build/skip for this configuration. -``` - -this means conda found Python 2 by default -- the easiest workaround is to add `--python 3` to the build command: -`conda build -c conda-forge --python 3 recipe` - - Near the end of a successful build, it should say where the built package can be found, eg. TEST END: /workspace/anaconda/conda-bld/osx-64/pyweed-0.5.2.dev1-py35hf6ed582_0.tar.bz2 @@ -147,8 +135,8 @@ $ which pyweed 1. Check in the changes to your forked GitHub repo. 2. Submit a pull request to the [base conda-forge repo](https://github.com/conda-forge/pyweed-feedstock). -3. You will need to wait until the automated build and test have succeeded. __This may take a day or so.__ +3. You will need to wait until the automated build and test have succeeded. **This may take a day or so.** 4. At that point, you should be able to approve the pull request. 5. You need to wait _again_ for the finalized packages to be built and uploaded. The easiest option is to watch -the [package page](https://anaconda.org/conda-forge/pyweed) which shows the latest available version for each -platform. When the new version is available for all platforms, the release is finished! + the [package page](https://anaconda.org/conda-forge/pyweed) which shows the latest available version for each + platform. When the new version is available for all platforms, the release is finished! diff --git a/Developer.md b/Developer.md index 1c5f923..0ce97a7 100644 --- a/Developer.md +++ b/Developer.md @@ -2,8 +2,8 @@ ## Python Libraries -* PyQt4 is used for all GUI components and handles the event loop -* ObsPy is used for data access other seismic related analysis and plotting +- PyQt5 is used for all GUI components and handles the event loop +- ObsPy is used for data access other seismic related analysis and plotting ## Qt Creator @@ -14,14 +14,11 @@ with the full installer, but you don't need the rest of it. Qt Creator works with XML-based `.ui` files, and PyQt includes a command to generate the relevant Python code from this. ``` -pyuic4 MainWindow.ui -o MainWindow.py +pyuic MainWindow.ui -o MainWindow.py ``` -Note that PyWEED uses Qt 4, which is an older version. (PyQt5 appears not to be fully supported on all platforms.) - ## [Deployment](Deployment.md) - # Old docs For reference: