Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: better travis link

...

  1. If you're not familiar with how to package a Python module and and share it on PyPI, get your bearings by reading this guide.
  2. Write a setup.py for your package.
    1. Make sure you:
      1. Indicate a license type, AGPL or Apache (license). Link to which license you should use: /wiki/spaces/OPEN/pages/13959332
      2. Indicate which packages your package requires in order to run (install_requires)
      3. Use "edX" as the package author (author)
      4. Use "oscm@edx.org" as the package author's email address (author_email)
    2. A simple example is here.
    3. If your package includes console scripts, see this example.
  3. Test your setup.py by publishing your package to the PyPI staging server.
    1. Create an account at https://testpypi.python.org/pypi.
    2. Follow the instructions in the guide linked above.
  4. Use the details at How to connect a repository to Travis CI to in the "Publish python package to PyPI" section of How to Enable Semantic Release through Github Actions to add deployment details to your .travis.yml.
  5. To publish a new version of your package to PyPI, update the version in setup.py, then push a corresponding tag to GitHub.
  6. You're done! Don't forget to update your requirements files so that they install your package from PyPI.

...