# pygenesis-django
Python Django package repository template
You can find **Full Project Documentation** [here][documentation_path]
<hr>
#### Workflows
[![Tests](https://github.com/libresource/pygenesis-django/actions/workflows/run-tests.yml/badge.svg?branch=main)](https://github.com/libresource/pygenesis-django/actions/workflows/run-tests.yml)
[![Pylint](https://github.com/libresource/pygenesis-django/actions/workflows/lint.yml/badge.svg?branch=main)](https://github.com/libresource/pygenesis-django/actions/workflows/lint.yml)
#### Package
[![Version](https://img.shields.io/pypi/v/pygenesis-django.svg)](https://pypi.python.org/pypi/pygenesis-django/)
[![Development Status](https://img.shields.io/pypi/status/pygenesis-django.svg)](https://pypi.python.org/pypi/pygenesis-django)
[![Python version](https://img.shields.io/pypi/pyversions/pygenesis-django.svg)](https://pypi.python.org/pypi/pygenesis-django/)
[![License](https://img.shields.io/pypi/l/pygenesis-django)](https://github.com/libresource/pygenesis-djangoblob/main/LICENSE)
[![Wheel](https://img.shields.io/pypi/wheel/pygenesis-django.svg)](https://pypi.python.org/pypi/pygenesis-django/)
#### 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-django/discussions/)
[![Issues](https://img.shields.io/badge/issues-11AE13.svg)](https://github.com/libresource/pygenesis-django/issues/)
#### Downloads
[![Day Downloads](https://img.shields.io/pypi/dd/pygenesis-django)](https://pepy.tech/project/pygenesis-django)
[![Week Downloads](https://img.shields.io/pypi/dw/pygenesis-django)](https://pepy.tech/project/pygenesis-django)
[![Month Downloads](https://img.shields.io/pypi/dm/pygenesis-django)](https://pepy.tech/project/pygenesis-django)
[![All Downloads](https://img.shields.io/pepy/dt/pygenesis-django)](https://pepy.tech/project/pygenesis-django)
#### Languages
[![Languages](https://img.shields.io/github/languages/count/libresource/pygenesis-django)](https://github.com/libresource/pygenesis-django)
[![Top Language](https://img.shields.io/github/languages/top/libresource/pygenesis-django)](https://github.com/libresource/pygenesis-django)
#### Development
- [![Release date](https://img.shields.io/github/release-date/libresource/pygenesis-django
)](https://github.com/libresource/pygenesis-django/releases)
[![Last Commit](https://img.shields.io/github/last-commit/libresource/pygenesis-django/main
)](https://github.com/libresource/pygenesis-django)
- [![Issues](https://img.shields.io/github/issues/libresource/pygenesis-django
)](https://github.com/libresource/pygenesis-django/issues/)
[![Closed Issues](https://img.shields.io/github/issues-closed/libresource/pygenesis-django
)](https://github.com/libresource/pygenesis-django/issues/)
- [![Pull Requests](https://img.shields.io/github/issues-pr/libresource/pygenesis-django
)](https://github.com/libresource/pygenesis-django/pulls)
[![Closed Pull Requests](https://img.shields.io/github/issues-pr-closed-raw/libresource/pygenesis-django
)](https://github.com/libresource/pygenesis-django/pulls)
- [![Discussions](https://img.shields.io/github/discussions/libresource/pygenesis-django
)](https://github.com/libresource/pygenesis-django/discussions/)
[//]: # (#### Repository Stats)
[//]: # ([![Stars](https://img.shields.io/github/stars/libresource/pygenesis-django)
[//]: # ()](https://github.com/libresource/pygenesis-django))
[//]: # ([![Contributors](https://img.shields.io/github/contributors/libresource/pygenesis-django)
[//]: # ()](https://github.com/libresource/pygenesis-djangographs/contributors))
[//]: # ([![Forks](https://img.shields.io/github/forks/libresource/pygenesis-django)
[//]: # ()](https://github.com/libresource/pygenesis-django))
<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-django is a comprehensive Python Django 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-django.
## 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/pygenesis](https://github.com/libresource/pygenesis).
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
## Requirements
- django, pylint, yamllint, sphinx, sphinx_rtd_theme
- See more in [Full Documentation](https://pygenesis-django.libresource.info/about.html#requirements)
## Development Status
- Package already available on [PyPi](https://pypi.org/project/pygenesis-django/)
- See more in [Full Documentation](https://pygenesis-django.libresource.info/about.html#development-status)
## Install
### with pip
```commandline
pip install pygenesis-django
```
See more in [Full Documentation](https://pygenesis-django.libresource.info/install.html)
## Quickstart
Add package to `INSTALLED_APPS`
```python
INSTALLED_APPS = [
...,
'pygenesis_django',
]
```
Run tests
```commandline
python manage.py test
```
Run info command
```commandline
python manage.py pygenesis_django_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-django.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-django.libresource.info
Raw data
{
"_id": null,
"home_page": "https://github.com/libresource/pygenesis-django",
"name": "pygenesis-django",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3",
"maintainer_email": null,
"keywords": "python, django, package, template-repository",
"author": "quillcraftsman",
"author_email": "quill@craftsman.lol",
"download_url": "https://files.pythonhosted.org/packages/43/c6/2db53dbc6a1972b930e5235d600ef3eb44c20900b489fa7708b0760121e8/pygenesis_django-0.1.1.tar.gz",
"platform": null,
"description": "# pygenesis-django\n\nPython Django 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-django/actions/workflows/run-tests.yml/badge.svg?branch=main)](https://github.com/libresource/pygenesis-django/actions/workflows/run-tests.yml)\n[![Pylint](https://github.com/libresource/pygenesis-django/actions/workflows/lint.yml/badge.svg?branch=main)](https://github.com/libresource/pygenesis-django/actions/workflows/lint.yml)\n\n#### Package\n[![Version](https://img.shields.io/pypi/v/pygenesis-django.svg)](https://pypi.python.org/pypi/pygenesis-django/)\n[![Development Status](https://img.shields.io/pypi/status/pygenesis-django.svg)](https://pypi.python.org/pypi/pygenesis-django)\n[![Python version](https://img.shields.io/pypi/pyversions/pygenesis-django.svg)](https://pypi.python.org/pypi/pygenesis-django/)\n[![License](https://img.shields.io/pypi/l/pygenesis-django)](https://github.com/libresource/pygenesis-djangoblob/main/LICENSE)\n[![Wheel](https://img.shields.io/pypi/wheel/pygenesis-django.svg)](https://pypi.python.org/pypi/pygenesis-django/)\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-django/discussions/)\n[![Issues](https://img.shields.io/badge/issues-11AE13.svg)](https://github.com/libresource/pygenesis-django/issues/)\n\n#### Downloads\n[![Day Downloads](https://img.shields.io/pypi/dd/pygenesis-django)](https://pepy.tech/project/pygenesis-django)\n[![Week Downloads](https://img.shields.io/pypi/dw/pygenesis-django)](https://pepy.tech/project/pygenesis-django)\n[![Month Downloads](https://img.shields.io/pypi/dm/pygenesis-django)](https://pepy.tech/project/pygenesis-django)\n[![All Downloads](https://img.shields.io/pepy/dt/pygenesis-django)](https://pepy.tech/project/pygenesis-django)\n\n#### Languages\n[![Languages](https://img.shields.io/github/languages/count/libresource/pygenesis-django)](https://github.com/libresource/pygenesis-django)\n[![Top Language](https://img.shields.io/github/languages/top/libresource/pygenesis-django)](https://github.com/libresource/pygenesis-django)\n\n#### Development\n- [![Release date](https://img.shields.io/github/release-date/libresource/pygenesis-django\n)](https://github.com/libresource/pygenesis-django/releases)\n[![Last Commit](https://img.shields.io/github/last-commit/libresource/pygenesis-django/main\n)](https://github.com/libresource/pygenesis-django)\n- [![Issues](https://img.shields.io/github/issues/libresource/pygenesis-django\n)](https://github.com/libresource/pygenesis-django/issues/)\n[![Closed Issues](https://img.shields.io/github/issues-closed/libresource/pygenesis-django\n)](https://github.com/libresource/pygenesis-django/issues/)\n- [![Pull Requests](https://img.shields.io/github/issues-pr/libresource/pygenesis-django\n)](https://github.com/libresource/pygenesis-django/pulls)\n[![Closed Pull Requests](https://img.shields.io/github/issues-pr-closed-raw/libresource/pygenesis-django\n)](https://github.com/libresource/pygenesis-django/pulls)\n- [![Discussions](https://img.shields.io/github/discussions/libresource/pygenesis-django\n)](https://github.com/libresource/pygenesis-django/discussions/)\n\n[//]: # (#### Repository Stats)\n\n[//]: # ([![Stars](https://img.shields.io/github/stars/libresource/pygenesis-django)\n\n[//]: # ()](https://github.com/libresource/pygenesis-django))\n\n[//]: # ([![Contributors](https://img.shields.io/github/contributors/libresource/pygenesis-django)\n\n[//]: # ()](https://github.com/libresource/pygenesis-djangographs/contributors))\n\n[//]: # ([![Forks](https://img.shields.io/github/forks/libresource/pygenesis-django)\n\n[//]: # ()](https://github.com/libresource/pygenesis-django))\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-django is a comprehensive Python Django 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-django.\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/pygenesis](https://github.com/libresource/pygenesis). \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\n## Requirements\n\n- django, pylint, yamllint, sphinx, sphinx_rtd_theme\n- See more in [Full Documentation](https://pygenesis-django.libresource.info/about.html#requirements)\n\n## Development Status\n\n- Package already available on [PyPi](https://pypi.org/project/pygenesis-django/)\n- See more in [Full Documentation](https://pygenesis-django.libresource.info/about.html#development-status)\n\n## Install\n\n### with pip\n\n```commandline\npip install pygenesis-django\n```\n\nSee more in [Full Documentation](https://pygenesis-django.libresource.info/install.html)\n\n## Quickstart\n\nAdd package to `INSTALLED_APPS`\n\n```python\nINSTALLED_APPS = [\n ...,\n 'pygenesis_django',\n]\n```\n\nRun tests\n\n```commandline\npython manage.py test\n```\n\nRun info command\n\n```commandline\npython manage.py pygenesis_django_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-django.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-django.libresource.info\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python Django package repository template",
"version": "0.1.1",
"project_urls": {
"Changelog": "https://github.com/libresource/pygenesis-django/releases",
"Documentation": "https://pygenesis-django.libresource.info",
"Download": "https://pypi.org/project/pygenesis-django/",
"Homepage": "https://github.com/libresource/pygenesis-django",
"Release notes": "https://github.com/libresource/pygenesis-django/releases",
"Source": "https://github.com/libresource/pygenesis-django",
"Tracker": "https://github.com/libresource/pygenesis-django/issues"
},
"split_keywords": [
"python",
" django",
" package",
" template-repository"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0ac0fcd009fe3a7c9980a032ae07833fcb1a5e28ca031434f9a55ed71dd99996",
"md5": "36b52348757f56c7c70575d91ec99c0e",
"sha256": "54fbb4bb938b1dd7ca56f860203a6b31389372bba1a28057d99667a1ddd93bc3"
},
"downloads": -1,
"filename": "pygenesis_django-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "36b52348757f56c7c70575d91ec99c0e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3",
"size": 6792,
"upload_time": "2024-08-11T10:04:36",
"upload_time_iso_8601": "2024-08-11T10:04:36.404642Z",
"url": "https://files.pythonhosted.org/packages/0a/c0/fcd009fe3a7c9980a032ae07833fcb1a5e28ca031434f9a55ed71dd99996/pygenesis_django-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "43c62db53dbc6a1972b930e5235d600ef3eb44c20900b489fa7708b0760121e8",
"md5": "1516cbaa1a8094a2a9a3be05ac6ff6c3",
"sha256": "5747c3075075f5d730e14aead22bd768faa5d57d5cc89190659da5448767b09d"
},
"downloads": -1,
"filename": "pygenesis_django-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "1516cbaa1a8094a2a9a3be05ac6ff6c3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3",
"size": 7634,
"upload_time": "2024-08-11T10:04:37",
"upload_time_iso_8601": "2024-08-11T10:04:37.744813Z",
"url": "https://files.pythonhosted.org/packages/43/c6/2db53dbc6a1972b930e5235d600ef3eb44c20900b489fa7708b0760121e8/pygenesis_django-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-11 10:04:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "libresource",
"github_project": "pygenesis-django",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "wheel",
"specs": []
},
{
"name": "Django",
"specs": [
[
"==",
"5.1"
]
]
}
],
"lcname": "pygenesis-django"
}