# 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
```
cd pypi_template
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/*
```
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": "newssources",
"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/e1/36/e2d6bd124d0f7f54f697bc004c20f3faa31041463c83ce130bac702d38a8/newssources-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\n```\ncd pypi_template\npython3 -m build\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\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",
"split_keywords": [
"sample",
"setuptools",
"development"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f1ad706b30fc333c3c50651f83c90254f7ef1ad5b36d40a4dbb17452f54ec87a",
"md5": "535f7715fd22c2f67b07b361a3efcee8",
"sha256": "c479657aa1947565ccb1f63fe712c9fd0f966eae30dc2060cc42f1b03a7385e4"
},
"downloads": -1,
"filename": "newssources-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "535f7715fd22c2f67b07b361a3efcee8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 2420,
"upload_time": "2023-03-19T14:31:09",
"upload_time_iso_8601": "2023-03-19T14:31:09.058826Z",
"url": "https://files.pythonhosted.org/packages/f1/ad/706b30fc333c3c50651f83c90254f7ef1ad5b36d40a4dbb17452f54ec87a/newssources-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e136e2d6bd124d0f7f54f697bc004c20f3faa31041463c83ce130bac702d38a8",
"md5": "1abaad01161f5c38b757de9f3c77163c",
"sha256": "1ade0053c857d6724d64b04befb119c9d09916c33b51585c50e9cfe097ec38fb"
},
"downloads": -1,
"filename": "newssources-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "1abaad01161f5c38b757de9f3c77163c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 3096,
"upload_time": "2023-03-19T14:31:11",
"upload_time_iso_8601": "2023-03-19T14:31:11.103548Z",
"url": "https://files.pythonhosted.org/packages/e1/36/e2d6bd124d0f7f54f697bc004c20f3faa31041463c83ce130bac702d38a8/newssources-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-19 14:31:11",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "newssources"
}
JSON