| Name | mprib-tools JSON |
| Version |
2023.1.1008
JSON |
| download |
| home_page | |
| Summary | Basic template of a python repository |
| upload_time | 2023-01-30 16:07:45 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.10 |
| license | |
| keywords |
basic
template
python
repository
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Basic Repo Template
This is a basic template repository for a python project.
Change the `package_name` in: `pyproject.toml` to the name of your package (doing a search and replace for the default string `mprib_tools` being careful to check folder and file names) *`NOTE` - This is pretty clunky and will be automated via a [cookiecutter](https://github.com/cookiecutter/cookiecutter) template "soon."*
You'll also want to change the `name`, `email` etc in `pyproject.toml` and `{repository_name}.__init__.py` to your own details.
## Publishing to PyPi (to make it pip installable)
NOTE - These instructions haven't been tested yet, this is placeholder text (written 2023-01-19)
You'll need to create a PyPi account and then create an API token for the Github Action configured in the file: `.github/workflows/publish_to_pypi_when_new_tag_is_pushed_to_main.yml`
These instructions may help you set that up! https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/
# Basic Setup
Clone the repo
Create a venv with:
```
python -m venv .venv
```
Make sure that .venv is active
From within the repo (which will have a subfolder named after the package), build the local wheel of the package:
```
python -m pip install -e .
```
This is a small change to test autopublish.
Raw data
{
"_id": null,
"home_page": "",
"name": "mprib-tools",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "basic,template,python,repository",
"author": "",
"author_email": "Mac Prible <prible@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/57/6d/ea2882bd48cf2dbc22b9fddcd189a331edd6f3c25e8c1d2a0208b4f26c1b/mprib_tools-2023.1.1008.tar.gz",
"platform": null,
"description": "# Basic Repo Template\n\nThis is a basic template repository for a python project. \n\nChange the `package_name` in: `pyproject.toml` to the name of your package (doing a search and replace for the default string `mprib_tools` being careful to check folder and file names) *`NOTE` - This is pretty clunky and will be automated via a [cookiecutter](https://github.com/cookiecutter/cookiecutter) template \"soon.\"*\n\n\nYou'll also want to change the `name`, `email` etc in `pyproject.toml` and `{repository_name}.__init__.py` to your own details.\n\n## Publishing to PyPi (to make it pip installable)\n\nNOTE - These instructions haven't been tested yet, this is placeholder text (written 2023-01-19)\n\nYou'll need to create a PyPi account and then create an API token for the Github Action configured in the file: `.github/workflows/publish_to_pypi_when_new_tag_is_pushed_to_main.yml` \n\nThese instructions may help you set that up! https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/\n\n\n# Basic Setup\n\nClone the repo\n\nCreate a venv with: \n\n```\npython -m venv .venv\n```\n\nMake sure that .venv is active\n\nFrom within the repo (which will have a subfolder named after the package), build the local wheel of the package: \n\n```\npython -m pip install -e .\n```\nThis is a small change to test autopublish.\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Basic template of a python repository",
"version": "2023.1.1008",
"split_keywords": [
"basic",
"template",
"python",
"repository"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "909314dca8b027ed4d69a0519f5e81dc6d8d149b8854625f650a38ceafa2bf39",
"md5": "ce7c6815a906f7f1e89696fd3ffdff66",
"sha256": "2722dc48066cb7bd22f2923d34a0d2c7ad1706dd2e04aa68d1d655011015d4a6"
},
"downloads": -1,
"filename": "mprib_tools-2023.1.1008-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ce7c6815a906f7f1e89696fd3ffdff66",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 6004,
"upload_time": "2023-01-30T16:07:44",
"upload_time_iso_8601": "2023-01-30T16:07:44.090462Z",
"url": "https://files.pythonhosted.org/packages/90/93/14dca8b027ed4d69a0519f5e81dc6d8d149b8854625f650a38ceafa2bf39/mprib_tools-2023.1.1008-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "576dea2882bd48cf2dbc22b9fddcd189a331edd6f3c25e8c1d2a0208b4f26c1b",
"md5": "366beb0cf00586c343aba57a999469a4",
"sha256": "fe8641f2de70c2517f79962d88bc427d7709db476cfe5c655ac98d1563c4296e"
},
"downloads": -1,
"filename": "mprib_tools-2023.1.1008.tar.gz",
"has_sig": false,
"md5_digest": "366beb0cf00586c343aba57a999469a4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 6381,
"upload_time": "2023-01-30T16:07:45",
"upload_time_iso_8601": "2023-01-30T16:07:45.736068Z",
"url": "https://files.pythonhosted.org/packages/57/6d/ea2882bd48cf2dbc22b9fddcd189a331edd6f3c25e8c1d2a0208b4f26c1b/mprib_tools-2023.1.1008.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-30 16:07:45",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "mprib-tools"
}
