updating the release docs
This commit is contained in:
parent
24e74ab873
commit
e4f89c93b5
|
@ -21,12 +21,37 @@ The commit that merged the version number bump is now the official release
|
||||||
commit for this release. You need an `API key <https://pypi.org/manage/account/#api-tokens>`_,
|
commit for this release. You need an `API key <https://pypi.org/manage/account/#api-tokens>`_,
|
||||||
which requires permissions to maintain the Lemur `project <https://pypi.org/project/lemur/>`_.
|
which requires permissions to maintain the Lemur `project <https://pypi.org/project/lemur/>`_.
|
||||||
|
|
||||||
|
For creating the release, follow these steps (more details `here <https://packaging.python.org/tutorials/packaging-projects/#generating-distribution-archives>`_)
|
||||||
|
|
||||||
|
* Make sure you have the latest versions of setuptools and wheel installed:
|
||||||
|
|
||||||
|
``python3 -m pip install --user --upgrade setuptools wheel``
|
||||||
|
|
||||||
|
* Now run this command from the same directory where setup.py is located:
|
||||||
|
|
||||||
|
``python3 setup.py sdist bdist_wheel``
|
||||||
|
|
||||||
|
* Once completed it should generate two files in the dist directory:
|
||||||
|
|
||||||
|
.. code-block:: pycon
|
||||||
|
|
||||||
|
$ ls dist/
|
||||||
|
lemur-0.8.0-py2.py3-none-any.whl lemur-0.8.0.tar.gz
|
||||||
|
|
||||||
|
|
||||||
|
* In this step, the distribution will be uploaded. You’ll need to install Twine:
|
||||||
|
|
||||||
``python3 -m pip install --user --upgrade twine``
|
``python3 -m pip install --user --upgrade twine``
|
||||||
|
|
||||||
|
* Once installed, run Twine to upload all of the archives under dist. Once installed, run Twine to upload all of the archives under dist:
|
||||||
|
|
||||||
``python3 -m twine upload --repository pypi dist/*``
|
``python3 -m twine upload --repository pypi dist/*``
|
||||||
|
|
||||||
The release should now be available on PyPI and a tag should be available in
|
The release should now be available on `PyPI Lemur <https://pypi.org/project/lemur/>`_ and a tag should be available in
|
||||||
the repository.
|
the repository.
|
||||||
|
|
||||||
|
Make sure to also make a github `release <https://github.com/Netflix/lemur/releases>`_ which will pick up the latest version.
|
||||||
|
|
||||||
Verifying the release
|
Verifying the release
|
||||||
---------------------
|
---------------------
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue