# PyPacking
## Use a short explanatory subtitle like, Create Python packages easily
<!-- Be sure to change `pypacking` for the name of your package -->
<!-- This are visual tags that you may add to your package at the beginning with useful information on your package -->
[](https://pypi.org/project/pypacking/)
[](https://pypi.org/project/pypacking/)
`PyPacking` is a Python package template. It provides the minimal set of
files and functionalities to create and distribute a python package
using `PyPI`. This `README` is one of the files you must provide with
the package. Change it according to the information you want to
provide the users.
To start a new package using this template follow this procedure (we
will assume that the name of your package is `mypack`):
- Get `pypacking` template: `git clone https://github.com/seap-udea/pypacking mypack`
- Remove the `.git` directory.
- Install system prerrequisites: `sudo apt install python3-pip gcc`
- Install python prerrequisites: `pip3 install build twine`
- Configure your package:
- Change variables in `.packrc`.
- Change key variables in setup file `setup.py`.
- Change package prerrequisites in `pyroject.toml`.
- Change package name in `src/__init__.py`
- Create an account in `PyPI` and get a token and place it in `$HOME/.pypirc`
- Release your first version: `make release VERSION=0.0.1`
Always start the README explaining clearly what your package do. If
you can include here some beautiful image to call the attention of the
potential user do it!
This is an example:
<p align="center"><img src="https://drive.google.com/uc?export=view&id=1XWnQLEt_oBJjVzMLFVGEAm_uh4zmiYvC" alt="Logo""/></p>
## Download and install
Describe here how the package can be downloaded and install it in
different arquitectures.
If you are using `PyPI` installation it's as simple as:
```
pip install pypacking
```
## Quick start
In this section you should provide the most simple instructions to use
your package.
For instance:
```
import pypacking
print(pypacking.version)
```
## Code examples
Provide some detailed examples for more advanced users.
For instance:
```
import pypacking
obj = MyClass()
```
## What's new
If your package will be frequently updated with new features include a
section describing the new features added to it:
Version 0.0.*:
- First version of the package.
------------
This package has been designed and written by Fulanit@ de Tal (C) 202X
Raw data
{
"_id": null,
"home_page": "https://pypi.org/project/pypacking",
"name": "pypacking",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "Python Package",
"author": "Fulan@ de Tal",
"author_email": "fulano.de.tal@macondo.co",
"download_url": "https://files.pythonhosted.org/packages/a2/5d/a9ffaba773b66a6bf45e380377972c87bf38391a472befba8f3205138018/pypacking-0.0.2.tar.gz",
"platform": null,
"description": "# PyPacking\n## Use a short explanatory subtitle like, Create Python packages easily\n<!-- Be sure to change `pypacking` for the name of your package -->\n\n<!-- This are visual tags that you may add to your package at the beginning with useful information on your package --> \n[](https://pypi.org/project/pypacking/)\n[](https://pypi.org/project/pypacking/)\n\n`PyPacking` is a Python package template. It provides the minimal set of\nfiles and functionalities to create and distribute a python package\nusing `PyPI`. This `README` is one of the files you must provide with\nthe package. Change it according to the information you want to\nprovide the users.\n\nTo start a new package using this template follow this procedure (we\nwill assume that the name of your package is `mypack`):\n\n- Get `pypacking` template: `git clone https://github.com/seap-udea/pypacking mypack`\n- Remove the `.git` directory.\n- Install system prerrequisites: `sudo apt install python3-pip gcc`\n- Install python prerrequisites: `pip3 install build twine`\n- Configure your package:\n - Change variables in `.packrc`.\n - Change key variables in setup file `setup.py`.\n - Change package prerrequisites in `pyroject.toml`.\n - Change package name in `src/__init__.py`\n- Create an account in `PyPI` and get a token and place it in `$HOME/.pypirc`\n- Release your first version: `make release VERSION=0.0.1`\n\nAlways start the README explaining clearly what your package do. If\nyou can include here some beautiful image to call the attention of the\npotential user do it!\n\nThis is an example:\n\n<p align=\"center\"><img src=\"https://drive.google.com/uc?export=view&id=1XWnQLEt_oBJjVzMLFVGEAm_uh4zmiYvC\" alt=\"Logo\"\"/></p>\n\n## Download and install\n\nDescribe here how the package can be downloaded and install it in\ndifferent arquitectures.\n\nIf you are using `PyPI` installation it's as simple as:\n\n```\npip install pypacking\n```\n\n\n## Quick start\n\nIn this section you should provide the most simple instructions to use\nyour package.\n\nFor instance:\n\n```\nimport pypacking\nprint(pypacking.version)\n```\n\n## Code examples\n\nProvide some detailed examples for more advanced users.\n\nFor instance:\n\n```\nimport pypacking\nobj = MyClass()\n```\n\n## What's new\n\nIf your package will be frequently updated with new features include a\nsection describing the new features added to it:\n\nVersion 0.0.*:\n\n- First version of the package.\n\n------------\n\nThis package has been designed and written by Fulanit@ de Tal (C) 202X\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python packaging made easy",
"version": "0.0.2",
"project_urls": {
"Homepage": "https://pypi.org/project/pypacking"
},
"split_keywords": [
"python",
"package"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a25da9ffaba773b66a6bf45e380377972c87bf38391a472befba8f3205138018",
"md5": "219034ecc46f5901cd7947e687623614",
"sha256": "40f0bb4fedec94ad5ccda81d21e886ffe768f44630fe65a4624f7a6481e2d0f3"
},
"downloads": -1,
"filename": "pypacking-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "219034ecc46f5901cd7947e687623614",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3878,
"upload_time": "2023-12-21T21:02:55",
"upload_time_iso_8601": "2023-12-21T21:02:55.594750Z",
"url": "https://files.pythonhosted.org/packages/a2/5d/a9ffaba773b66a6bf45e380377972c87bf38391a472befba8f3205138018/pypacking-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-21 21:02:55",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "pypacking"
}
JSON