Package: hyperfast-python-template
Hyperfast Python TemplateStreamlining Python Project Development with a Comprehensive Toolset for Quality, Efficiency, and MaintainabilityDocumentation:https://hyperfast-python.entelecheia.aiGitHub:https://github.com/entelecheia/hyperfast-python-templatePyPI:https://pypi.org/project/hyperfast-python-templateThe Hyperfast Python Template is a powerful and comprehensive solution designed to accelerate the development and maintenance of high-quality Python projects. By incorporating industry best practices and automating key aspects such as dependency management, releases, code formatting, testing, and documentation, this template streamlines the entire development process. It ensures code quality through continuous integration, coverage reporting, linting, and static type-checking while providing seamless support for Conventional Commits and Semantic Versioning. With the Hyperfast Python Template, developers can efficiently create and manage Python projects, focusing on their core functionality while enjoying a robust, well-organized, and maintainable codebase.QuickstartThere are two ways to use this project:Use [Copier] to create a project to your local machine directlyInject [Hyperfast Python Template] into an existing projectI. Use CopierInstall CopierpipxinstallcopierRuncopiercopy--trustgh:entelecheia/hyperfast-python-templatepath/to/destinationDo your workII. Inject the templateInstall CopierpipxinstallcopierFrom the root of your project, runcopiercopy--trustgh:entelecheia/hyperfast-python-template.Do your workManaging Actions Secrets and Variables in Your ProjectWhen using the HyFI-Template for your project, there are several GitHub Actions secrets and variables that you need to add to ensure proper functioning of the release action and optional JupyterBook deployment.Adding PYPI_API_TOKEN and TEST_PYPI_API_TOKENTo automate the release process of your project to PyPI, you need to provide two tokens:PYPI_API_TOKENandTEST_PYPI_API_TOKEN. These tokens will be used by the GitHub Actions workflow to authenticate with PyPI and TestPyPI, respectively.Generate an API token for your PyPI account by following the instructions in theofficial PyPI documentation.Generate an API token for your TestPyPI account by following the instructions in theofficial TestPyPI documentation.In your GitHub repository, go to the "Settings" tab and click on "Secrets" in the left sidebar.Click the "New repository secret" button.Add thePYPI_API_TOKENsecret with the value set to the token generated for your PyPI account.Add theTEST_PYPI_API_TOKENsecret with the value set to the token generated for your TestPyPI account.By providing these tokens, your project's release action will have the necessary permissions to publish your package to PyPI and TestPyPI.Optionally Adding CNAME for JupyterBook DeploymentIf you plan to deploy the JupyterBook documentation to a custom domain, you'll need to add aCNAMEvariable to your GitHub repository.In your GitHub repository, go to the "Settings" tab and click on "Pages" in the left sidebar.Follow the instructions to configure your custom domain.In your GitHub repository, go to the "Settings" tab and click on "Repository Variables" in the left sidebar.Click the "New repository variable" button.Add a new variable with the keyCNAMEand set the value to your custom domain (e.g.,your-custom-domain.com).By adding theCNAMEvariable, the GitHub Pages action in yourdeploy-docs.yamlworkflow will properly configure the deployment to use your custom domain.With theCNAMErepository variable properly configured, your project will be set up to handle JupyterBook deployment to your custom domain effectively.ChangelogSee theCHANGELOGfor more information.ContributingContributions are welcome! Please see thecontributing guidelinesfor more information.LicenseThis project is released under theMIT License.