Skip to content

Latest commit

 

History

History
149 lines (80 loc) · 3.49 KB

DEVELOPMENT.md

File metadata and controls

149 lines (80 loc) · 3.49 KB
Raw

Publishing:

Publishing takes the following steps:

  1. Create distribution package and upload to PyPI.
  2. Make a tagged release on GitHub.

Summary:

Assuming you have properly configured your ~/.pypirc file:

python setup.py sdist bdist_wheel
twine check dist/*
twine upload -r testpypi dist/*
twine upload -r pypi dist/*

git commit -m "Release <version>."
git tag -a "Release <version>".
git push --tags

Check:

Create PyPI distribution release:

Create distribution package:

$ python setup.py sdist bdist_wheel

Perform basic local package checks (e.g. that the long_description will render properly):

$ python -m twine check dist/*

Test the package by uploading to test server, using either setuptools or twine:

$ python -m twine upload --repository-url https://test.pypi.org/legacy/ dist/*

Check the project page on the test server: https://test.pypi.org/project/actionista-todoist/

Upload the distribution package to PyPI, using either setuptools or twine:

$ python -m twine upload dist/*

OBS: You can also use good old setuptools to upload, but it may or may not be secure:

$ python setup.py upload dist/*

You can use a .pypirc file to store your PyPI credentials. You can also set TWINE_ environment variables, or use keyring package.

Refs:

Alternative options (not currently used):

Using poetry:

$ poetry publish

Using flit:

$ flit publish

Using hatch:

$ hatch release

Create GitHub release:

Two options:

Documentations:

Documentation options, overview:

  • Sphinx + ReadTheDocs - now with "reasonable" Markdown support.
  • MkDocs + GitHub Pages.
    • MkDocs builds Markdown documentation to static HTML, which can be served however you'd like, e.g. with GitHub Pages.
    • With GitHub pages, the docs lives in a separate branch of your repository, gh-pages by default. You can publish docs with MkDocs directly to gh-pages using mkdocs gh-deploy.
  • MkDocs + ReadTheDocs: https://read-the-docs.readthedocs.io/en/latest/intro/getting-started-with-mkdocs.html.

MkDocs:

Local initialization, building and serving:

  1. Init new project using: mkdocs new .. This will create a mkdocs.yml configuration file.
  2. Edit index.md and add other doc files.
  3. Serve locally, mkdocs serve.
  4. Edit mkdocs.yml, updating site_name: and nav: (and optionally theme:).
  5. Build: mkdocs build.
    • Add site/ to .gitignore if you haven't done so already. echo "site/" >> .gitignore.

MkDocs deployment, options:

  1. Deploy as GitHub Pages: mkdocs gh-deploy.
  2. Import to ReadTheDocs.

MkDocs + ReadTheDocs

I've imported this project to ReadTheDocs. Since I use GitHub to authenticate with ReadTheDocs, a webhook was automatically configured, so ReadTheDocs are updated every time I push to GitHub.

I'm also using a .readthedocs.yml file in my project root to configure ReadTheDocs. This just specifies the configuration file version, and which mkdocs config file to use. (This could also have been configured during ReadTheDocs project import.)