# PyGenesis
Python package repository template
You can find **Full Project Documentation** [here][documentation_path]
<hr>
#### Workflows
[![Tests](https://github.com/libresource/pygenesis/actions/workflows/run-tests.yml/badge.svg?branch=main)](https://github.com/libresource/pygenesis/actions/workflows/run-tests.yml)
[![Pylint](https://github.com/libresource/pygenesis/actions/workflows/lint.yml/badge.svg?branch=main)](https://github.com/libresource/pygenesis/actions/workflows/lint.yml)
#### Package
[![Version](https://img.shields.io/pypi/v/pygenesis.svg)](https://pypi.python.org/pypi/pygenesis/)
[![Development Status](https://img.shields.io/pypi/status/pygenesis.svg)](https://pypi.python.org/pypi/pygenesis)
[![Python version](https://img.shields.io/pypi/pyversions/pygenesis.svg)](https://pypi.python.org/pypi/pygenesis/)
[![License](https://img.shields.io/pypi/l/pygenesis)](https://github.com/libresource/pygenesisblob/main/LICENSE)
[![Wheel](https://img.shields.io/pypi/wheel/pygenesis.svg)](https://pypi.python.org/pypi/pygenesis/)
#### Support
[![Documentation](https://img.shields.io/badge/docs-0094FF.svg)][documentation_path]
[![Discussions](https://img.shields.io/badge/discussions-ff0068.svg)](https://github.com/libresource/pygenesis/discussions/)
[![Issues](https://img.shields.io/badge/issues-11AE13.svg)](https://github.com/libresource/pygenesis/issues/)
#### Downloads
[![Day Downloads](https://img.shields.io/pypi/dd/pygenesis)](https://pepy.tech/project/pygenesis)
[![Week Downloads](https://img.shields.io/pypi/dw/pygenesis)](https://pepy.tech/project/pygenesis)
[![Month Downloads](https://img.shields.io/pypi/dm/pygenesis)](https://pepy.tech/project/pygenesis)
[![All Downloads](https://img.shields.io/pepy/dt/pygenesis)](https://pepy.tech/project/pygenesis)
#### Languages
[![Languages](https://img.shields.io/github/languages/count/libresource/pygenesis)](https://github.com/libresource/pygenesis)
[![Top Language](https://img.shields.io/github/languages/top/libresource/pygenesis)](https://github.com/libresource/pygenesis)
#### Development
- [![Release date](https://img.shields.io/github/release-date/libresource/pygenesis
)](https://github.com/libresource/pygenesis/releases)
[![Last Commit](https://img.shields.io/github/last-commit/libresource/pygenesis/main
)](https://github.com/libresource/pygenesis)
- [![Issues](https://img.shields.io/github/issues/libresource/pygenesis
)](https://github.com/libresource/pygenesis/issues/)
[![Closed Issues](https://img.shields.io/github/issues-closed/libresource/pygenesis
)](https://github.com/libresource/pygenesis/issues/)
- [![Pull Requests](https://img.shields.io/github/issues-pr/libresource/pygenesis
)](https://github.com/libresource/pygenesis/pulls)
[![Closed Pull Requests](https://img.shields.io/github/issues-pr-closed-raw/libresource/pygenesis
)](https://github.com/libresource/pygenesis/pulls)
- [![Discussions](https://img.shields.io/github/discussions/libresource/pygenesis
)](https://github.com/libresource/pygenesis/discussions/)
[//]: # (#### Repository Stats)
[//]: # ([![Stars](https://img.shields.io/github/stars/libresource/pygenesis)
[//]: # ()](https://github.com/libresource/pygenesis))
[//]: # ([![Contributors](https://img.shields.io/github/contributors/libresource/pygenesis)
[//]: # ()](https://github.com/libresource/pygenesisgraphs/contributors))
[//]: # ([![Forks](https://img.shields.io/github/forks/libresource/pygenesis)
[//]: # ()](https://github.com/libresource/pygenesis))
<hr>
## Menu
- [Mission](#mission)
- [Open Source Project](#open-source-project)
- [Features](#features)
- [Requirements](#requirements)
- [Development Status](#development-status)
- [Install](#install)
- [Quickstart](#quickstart)
- [Contributing](#contributing)
## Mission
PyGenesis is a comprehensive Python package template designed to kickstart your projects instantly.
With a clean and organized structure, it provides a hassle-free starting point for developers.
Effortlessly begin your Python endeavors, focusing on your code, not the setup. Jumpstart your creativity with PyGenesis.
## Open Source Project
This is the open source project with [MIT license](LICENSE).
Be free to use, fork, clone and contribute.
## Features
- This README (Change it for your python project)
- This template base on [libresource/open-source-checklist](https://github.com/libresource/open-source-checklist).
It contains may useful files for open source project: ([CHECKLIST.md](CHECKLIST.md), [CONTRIBUTING.md](CONTRIBUTING.md),
[CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md), and much more).
- `setup.py` for build your package
- `requirements.txt` and `dev-requirements.txt`
- `Makefile` with main commands to work with the project
- run tests
- calculate coverage
- lint
- build and install package
- generate autodocumentation
- others
- GitHub workflows
- generate documentation
- run tests with coverage
- run linter
- publish your package in PyPi
- greetings for new contributors
## Requirements
- pytest, pytest-cov, pylint, yamllint, sphinx, sphinx_rtd_theme
- See more in [Full Documentation](https://pygenesis.libresource.info/about.html#requirements)
## Development Status
- Package already available on [PyPi](https://pypi.org/project/pygenesis/)
- See more in [Full Documentation](https://pygenesis.libresource.info/about.html#development-status)
## Install
### with pip
```commandline
pip install pygenesis
```
See more in [Full Documentation](https://pygenesis.libresource.info/install.html)
## Quickstart
```python
from pygenesis import info
print(info())
```
### More examples in [Full Documentation][documentation_path]
## Contributing
You are welcome! To easy start please check:
- [Full Documentation][documentation_path]
- [Contributing](CONTRIBUTING.md)
- [Developer Documentation](https://pygenesis.libresource.info/dev_documentation.html)
- [Code of Conduct](CODE_OF_CONDUCT.md)
- [Security Policy](SECURITY.md)
- [Governance](GOVERNANCE.md)
- [Support](SUPPORT.md)
[documentation_path]: https://pygenesis.libresource.info
Raw data
{
"_id": null,
"home_page": "https://github.com/libresource/pygenesis",
"name": "pygenesis",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3",
"maintainer_email": "",
"keywords": "python,package,template-repository",
"author": "quillcraftsman",
"author_email": "quill@craftsman.lol",
"download_url": "https://files.pythonhosted.org/packages/5d/b9/34bef688d9dd47d21012382a8f7b2b0e88bacc1914058cf3b9c144e13da2/pygenesis-1.1.0.tar.gz",
"platform": null,
"description": "# PyGenesis\n\nPython package repository template\n\nYou can find **Full Project Documentation** [here][documentation_path]\n\n<hr>\n\n#### Workflows\n[![Tests](https://github.com/libresource/pygenesis/actions/workflows/run-tests.yml/badge.svg?branch=main)](https://github.com/libresource/pygenesis/actions/workflows/run-tests.yml)\n[![Pylint](https://github.com/libresource/pygenesis/actions/workflows/lint.yml/badge.svg?branch=main)](https://github.com/libresource/pygenesis/actions/workflows/lint.yml)\n\n#### Package\n[![Version](https://img.shields.io/pypi/v/pygenesis.svg)](https://pypi.python.org/pypi/pygenesis/)\n[![Development Status](https://img.shields.io/pypi/status/pygenesis.svg)](https://pypi.python.org/pypi/pygenesis)\n[![Python version](https://img.shields.io/pypi/pyversions/pygenesis.svg)](https://pypi.python.org/pypi/pygenesis/)\n[![License](https://img.shields.io/pypi/l/pygenesis)](https://github.com/libresource/pygenesisblob/main/LICENSE)\n[![Wheel](https://img.shields.io/pypi/wheel/pygenesis.svg)](https://pypi.python.org/pypi/pygenesis/)\n\n#### Support\n[![Documentation](https://img.shields.io/badge/docs-0094FF.svg)][documentation_path]\n[![Discussions](https://img.shields.io/badge/discussions-ff0068.svg)](https://github.com/libresource/pygenesis/discussions/)\n[![Issues](https://img.shields.io/badge/issues-11AE13.svg)](https://github.com/libresource/pygenesis/issues/)\n\n#### Downloads\n[![Day Downloads](https://img.shields.io/pypi/dd/pygenesis)](https://pepy.tech/project/pygenesis)\n[![Week Downloads](https://img.shields.io/pypi/dw/pygenesis)](https://pepy.tech/project/pygenesis)\n[![Month Downloads](https://img.shields.io/pypi/dm/pygenesis)](https://pepy.tech/project/pygenesis)\n[![All Downloads](https://img.shields.io/pepy/dt/pygenesis)](https://pepy.tech/project/pygenesis)\n\n#### Languages\n[![Languages](https://img.shields.io/github/languages/count/libresource/pygenesis)](https://github.com/libresource/pygenesis)\n[![Top Language](https://img.shields.io/github/languages/top/libresource/pygenesis)](https://github.com/libresource/pygenesis)\n\n#### Development\n- [![Release date](https://img.shields.io/github/release-date/libresource/pygenesis\n)](https://github.com/libresource/pygenesis/releases)\n[![Last Commit](https://img.shields.io/github/last-commit/libresource/pygenesis/main\n)](https://github.com/libresource/pygenesis)\n- [![Issues](https://img.shields.io/github/issues/libresource/pygenesis\n)](https://github.com/libresource/pygenesis/issues/)\n[![Closed Issues](https://img.shields.io/github/issues-closed/libresource/pygenesis\n)](https://github.com/libresource/pygenesis/issues/)\n- [![Pull Requests](https://img.shields.io/github/issues-pr/libresource/pygenesis\n)](https://github.com/libresource/pygenesis/pulls)\n[![Closed Pull Requests](https://img.shields.io/github/issues-pr-closed-raw/libresource/pygenesis\n)](https://github.com/libresource/pygenesis/pulls)\n- [![Discussions](https://img.shields.io/github/discussions/libresource/pygenesis\n)](https://github.com/libresource/pygenesis/discussions/)\n\n[//]: # (#### Repository Stats)\n\n[//]: # ([![Stars](https://img.shields.io/github/stars/libresource/pygenesis)\n\n[//]: # ()](https://github.com/libresource/pygenesis))\n\n[//]: # ([![Contributors](https://img.shields.io/github/contributors/libresource/pygenesis)\n\n[//]: # ()](https://github.com/libresource/pygenesisgraphs/contributors))\n\n[//]: # ([![Forks](https://img.shields.io/github/forks/libresource/pygenesis)\n\n[//]: # ()](https://github.com/libresource/pygenesis))\n\n<hr>\n\n## Menu\n\n- [Mission](#mission)\n- [Open Source Project](#open-source-project)\n- [Features](#features)\n- [Requirements](#requirements)\n- [Development Status](#development-status)\n- [Install](#install)\n- [Quickstart](#quickstart)\n- [Contributing](#contributing)\n\n## Mission\n\nPyGenesis is a comprehensive Python package template designed to kickstart your projects instantly. \nWith a clean and organized structure, it provides a hassle-free starting point for developers. \nEffortlessly begin your Python endeavors, focusing on your code, not the setup. Jumpstart your creativity with PyGenesis.\n\n## Open Source Project\n\nThis is the open source project with [MIT license](LICENSE). \nBe free to use, fork, clone and contribute.\n\n## Features\n\n- This README (Change it for your python project)\n- This template base on [libresource/open-source-checklist](https://github.com/libresource/open-source-checklist). \nIt contains may useful files for open source project: ([CHECKLIST.md](CHECKLIST.md), [CONTRIBUTING.md](CONTRIBUTING.md), \n[CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md), and much more). \n- `setup.py` for build your package\n- `requirements.txt` and `dev-requirements.txt`\n- `Makefile` with main commands to work with the project\n - run tests\n - calculate coverage\n - lint\n - build and install package\n - generate autodocumentation\n - others\n- GitHub workflows \n - generate documentation\n - run tests with coverage\n - run linter\n - publish your package in PyPi\n - greetings for new contributors\n\n## Requirements\n\n- pytest, pytest-cov, pylint, yamllint, sphinx, sphinx_rtd_theme\n- See more in [Full Documentation](https://pygenesis.libresource.info/about.html#requirements)\n\n## Development Status\n\n- Package already available on [PyPi](https://pypi.org/project/pygenesis/)\n- See more in [Full Documentation](https://pygenesis.libresource.info/about.html#development-status)\n\n## Install\n\n### with pip\n\n```commandline\npip install pygenesis\n```\n\nSee more in [Full Documentation](https://pygenesis.libresource.info/install.html)\n\n## Quickstart\n\n```python\nfrom pygenesis import info\n\nprint(info())\n```\n\n### More examples in [Full Documentation][documentation_path]\n\n## Contributing\n\nYou are welcome! To easy start please check:\n- [Full Documentation][documentation_path]\n- [Contributing](CONTRIBUTING.md)\n- [Developer Documentation](https://pygenesis.libresource.info/dev_documentation.html)\n- [Code of Conduct](CODE_OF_CONDUCT.md)\n- [Security Policy](SECURITY.md)\n- [Governance](GOVERNANCE.md)\n- [Support](SUPPORT.md)\n\n[documentation_path]: https://pygenesis.libresource.info\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python package repository template",
"version": "1.1.0",
"project_urls": {
"Changelog": "https://github.com/libresource/pygenesis/releases",
"Documentation": "https://pygenesis.libresource.info",
"Download": "https://pypi.org/project/pygenesis/",
"Homepage": "https://github.com/libresource/pygenesis",
"Release notes": "https://github.com/libresource/pygenesis/releases",
"Source": "https://github.com/libresource/pygenesis",
"Tracker": "https://github.com/libresource/pygenesis/issues"
},
"split_keywords": [
"python",
"package",
"template-repository"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7f7efaba634724c15d96642957a683e8124f546b1a7ae7f938a809122a6c5231",
"md5": "d6a1b30e4c2458409b3824ec219e9e8a",
"sha256": "b7c89ddfcdda71ea99925a5584340466477a032153fc1cf7d8f1c228058a522a"
},
"downloads": -1,
"filename": "pygenesis-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d6a1b30e4c2458409b3824ec219e9e8a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3",
"size": 4630,
"upload_time": "2024-03-13T10:11:17",
"upload_time_iso_8601": "2024-03-13T10:11:17.798167Z",
"url": "https://files.pythonhosted.org/packages/7f/7e/faba634724c15d96642957a683e8124f546b1a7ae7f938a809122a6c5231/pygenesis-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5db934bef688d9dd47d21012382a8f7b2b0e88bacc1914058cf3b9c144e13da2",
"md5": "6e2c81795cbc9b15e29c699f70277d10",
"sha256": "4528d584ccfa66d928dffd5a40f19ea18d1c7db6e0a0125575b06b0d7d916666"
},
"downloads": -1,
"filename": "pygenesis-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "6e2c81795cbc9b15e29c699f70277d10",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3",
"size": 4912,
"upload_time": "2024-03-13T10:11:19",
"upload_time_iso_8601": "2024-03-13T10:11:19.478320Z",
"url": "https://files.pythonhosted.org/packages/5d/b9/34bef688d9dd47d21012382a8f7b2b0e88bacc1914058cf3b9c144e13da2/pygenesis-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-13 10:11:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "libresource",
"github_project": "pygenesis",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "wheel",
"specs": []
}
],
"lcname": "pygenesis"
}