"Python Package Hosting Helpers" enhance the user experience on GitHub for hosting Python packages. It offers various features to facilitate package versioning, documentation and dependency management.
Github is a comprehensive software solution that offers various features, such as Git repository hosting, a download page for your Git tags or any archive, an issue tracker, a wiki, and static page hosting (gh-pages). It is an ideal platform for hosting Python packages and their documentation. However, problems arise with the setup of gh-pages, especially when using Sphinx, as the setup can be quite complex. Sphinx places source and static files in directories named "_source" and "_static," which gh-pages cannot serve. In such cases, the Sphinx extension called (github.tools.sphinx) resolves this issue with ease. Moreover, some paver tasks (github.tools.task.*) take care of the creation of a Git submodule to host the built html documentation.
The installation process of Github is relatively simple. Assuming easy_install is installed, execute the command: easy_install github-tools. Once installed, create the basic package layout with paster by executing the paster create -t gh_package < project name > command. The project name will be used for pypi and your Github repository. The project details are saved in src/< package name >/__init__.py. In addition, to finalize your development environment setup, create a virtual environment and deploy your package in development mode using the python bootstrap.py --no-site-packages command.
Paver comes equipped with a setup.py file and a portable paver library crucial for setup.py. Additionally, during development mode, the src folder containing your package is added to the python path, allowing you to write your package in src/ and its documentation in docs/source. Moreover, to track your project, execute the following command: git init git add . git commit -m "initial import."
Once you are ready to share your work, create a repository at GitHub and push your local repository. Paver does this seamlessly only after setting up your Github user name and token using the commands git config --global github.user < user > and git config --global github.token < token >. Additionally, Paver allows you to create your gh-pages branch and upload it to GitHub by executing the paver gh_pages_create gh_html command.
In summary, Github is an excellent software solution for hosting Python packages and their documentation. Its wide range of features, including Git repository hosting, a download page for Git tags, an issue tracker, a wiki, and static page hosting (gh-pages), make it a must-have for developers. Though it may require some mild complexity with Sphinx, Github solves those issues, ensuring that you can fully develop, document and host your projects.
The installation process of Github is relatively simple. Assuming easy_install is installed, execute the command: easy_install github-tools. Once installed, create the basic package layout with paster by executing the paster create -t gh_package < project name > command. The project name will be used for pypi and your Github repository. The project details are saved in src/< package name >/__init__.py. In addition, to finalize your development environment setup, create a virtual environment and deploy your package in development mode using the python bootstrap.py --no-site-packages command.
Paver comes equipped with a setup.py file and a portable paver library crucial for setup.py. Additionally, during development mode, the src folder containing your package is added to the python path, allowing you to write your package in src/ and its documentation in docs/source. Moreover, to track your project, execute the following command: git init git add . git commit -m "initial import."
Once you are ready to share your work, create a repository at GitHub and push your local repository. Paver does this seamlessly only after setting up your Github user name and token using the commands git config --global github.user < user > and git config --global github.token < token >. Additionally, Paver allows you to create your gh-pages branch and upload it to GitHub by executing the paver gh_pages_create gh_html command.
In summary, Github is an excellent software solution for hosting Python packages and their documentation. Its wide range of features, including Git repository hosting, a download page for Git tags, an issue tracker, a wiki, and static page hosting (gh-pages), make it a must-have for developers. Though it may require some mild complexity with Sphinx, Github solves those issues, ensuring that you can fully develop, document and host your projects.
What's New
Version 0.1.7 / 0.2 Beta 1: N/A