# Requirements
```
python3 -m pip install --upgrade build
python3 -m pip install --upgrade twine
python3 -m pip install --upgrade setuptools wheel
```
# Download repository:
```
git clone https://github.com/johanneskruse/pypi_template.git
```
# Upload:
In *pyproject.toml* you can set the name of the pacakage
## Run the following to upload:
[Packaging Python Projects](https://packaging.python.org/en/latest/tutorials/packaging-projects/)
### Generating distribution archives
Stand inside the project, i.e.
```
cd pypi_template
```
Next build the package:
```
python3 -m build
```
This command should output a lot of text and once completed should generate two files in the dist directory:
```
dist/
├── sampleproject-0.0.1-py3-none-any.whl
└── sampleproject-0.0.1.tar.gz
```
### Uploading the distribution archives
```
twine upload dist/*
```
The user name and the password is the following:
```
[pypi]
username = __token__
password = .....
```
Where you'll need to generate the [API Token](https://pypi.org/manage/account/token/) as password.
Go to https://pypi.org/ to see the package!
# Inspiration
[setup.py vs setup.cfg in Python](https://towardsdatascience.com/setuptools-python-571e7d5500f2#:~:text=be%20more%20appropriate.-,The%20setup.,as%20the%20command%20line%20interface.)
[sample git repo project](https://github.com/pypa/sampleproject)
[Packaging Python Projects](https://packaging.python.org/en/latest/tutorials/packaging-projects/)
TODO:
- Setup with pyproject.toml file
- Note that if you want to install packages in editable mode (i.e. by running pip install -e .) you must have a valid setup.py file apart from setup.cfg and pyproject.toml. TRY TO RUN INSTEAD: pip install -e . -f .
# Acronym Generator (help generate the name)
https://acronymify.com/
Raw data
{
"_id": null,
"home_page": "",
"name": "rats",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "\"A. Great Maintainer\" <maintainer@example.com>",
"keywords": "sample,setuptools,development",
"author": "",
"author_email": "\"A. Random Developer\" <author@example.com>",
"download_url": "https://files.pythonhosted.org/packages/0e/d2/82e6d8644f204a3e240066e68228cb4500f0a07acc6d0fe057a8252ab5d0/rats-0.0.1.tar.gz",
"platform": null,
"description": "\n# Requirements\n```\npython3 -m pip install --upgrade build\npython3 -m pip install --upgrade twine\npython3 -m pip install --upgrade setuptools wheel\n```\n\n# Download repository: \n``` \ngit clone https://github.com/johanneskruse/pypi_template.git\n```\n\n# Upload:\n\nIn *pyproject.toml* you can set the name of the pacakage\n\n## Run the following to upload: \n[Packaging Python Projects](https://packaging.python.org/en/latest/tutorials/packaging-projects/)\n### Generating distribution archives\nStand inside the project, i.e.\n```\ncd pypi_template\n```\nNext build the package:\n```\npython3 -m build\n```\n\nThis command should output a lot of text and once completed should generate two files in the dist directory:\n```\ndist/\n\u251c\u2500\u2500 sampleproject-0.0.1-py3-none-any.whl\n\u2514\u2500\u2500 sampleproject-0.0.1.tar.gz\n```\n### Uploading the distribution archives\n```\ntwine upload dist/*\n```\n\nThe user name and the password is the following:\n```\n[pypi]\n username = __token__\n password = .....\n```\nWhere you'll need to generate the [API Token](https://pypi.org/manage/account/token/) as password.\n\nGo to https://pypi.org/ to see the package! \n\n\n# Inspiration\n[setup.py vs setup.cfg in Python](https://towardsdatascience.com/setuptools-python-571e7d5500f2#:~:text=be%20more%20appropriate.-,The%20setup.,as%20the%20command%20line%20interface.)\n\n[sample git repo project](https://github.com/pypa/sampleproject)\n\n[Packaging Python Projects](https://packaging.python.org/en/latest/tutorials/packaging-projects/)\n\nTODO: \n- Setup with pyproject.toml file\n- Note that if you want to install packages in editable mode (i.e. by running pip install -e .) you must have a valid setup.py file apart from setup.cfg and pyproject.toml. TRY TO RUN INSTEAD: pip install -e . -f .\n\n# Acronym Generator (help generate the name)\n\nhttps://acronymify.com/\n",
"bugtrack_url": null,
"license": "Copyright (c) 2022 TBA",
"summary": "A sample Python project",
"version": "0.0.1",
"project_urls": null,
"split_keywords": [
"sample",
"setuptools",
"development"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "01056c6f53c9e95e9e713a36963d087991da2c2a49b5998c4aa2d3f3d9a708e3",
"md5": "5fbe4e605eba50417a2b41f9bae7863e",
"sha256": "d1104f468b1919d78e6da3748c113b6d7bcfd4e2320117705ab353f3a480f6ac"
},
"downloads": -1,
"filename": "rats-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5fbe4e605eba50417a2b41f9bae7863e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 2464,
"upload_time": "2024-03-01T12:46:54",
"upload_time_iso_8601": "2024-03-01T12:46:54.457954Z",
"url": "https://files.pythonhosted.org/packages/01/05/6c6f53c9e95e9e713a36963d087991da2c2a49b5998c4aa2d3f3d9a708e3/rats-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0ed282e6d8644f204a3e240066e68228cb4500f0a07acc6d0fe057a8252ab5d0",
"md5": "fcad7092e98c1ecc64dee6ddf64b472c",
"sha256": "d0057b469cf3e66c2d2786aeb5a6ce47353fd3028b2b5c908010cd4cc95a3080"
},
"downloads": -1,
"filename": "rats-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "fcad7092e98c1ecc64dee6ddf64b472c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 3252,
"upload_time": "2024-03-01T12:46:57",
"upload_time_iso_8601": "2024-03-01T12:46:57.898809Z",
"url": "https://files.pythonhosted.org/packages/0e/d2/82e6d8644f204a3e240066e68228cb4500f0a07acc6d0fe057a8252ab5d0/rats-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-01 12:46:57",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "rats"
}
JSON