| Name | usethis JSON |
| Version |
0.2.0
JSON |
| download |
| home_page | None |
| Summary | Automate Python project setup and development tasks that are otherwise performed manually. |
| upload_time | 2024-10-30 23:16:24 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.12 |
| license | MIT License Copyright (c) 2024 Nathan McDougall Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
init
project
setup
start
usethis
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# usethis
Automate Python project setup and development tasks that are otherwise performed manually.
Inspired by an [**R** package of the same name](https://usethis.r-lib.org/index.html),
this package brings a similar experience to the Python ecosystem as a CLI tool.
## Highlights
- First-class support for state-of-the-practice tooling: `uv`, `ruff`, `pytest`, and `pre-commit`.
- Automatically add and remove tools: declare, install, and configure in one step.
- Powerful knowledge of how different tools interact and sensible defaults.
- Get started on a new Python project or a new workflow in seconds.
## Getting Started
First, it is strongly recommended you [install the `uv` package manager](https://docs.astral.sh/uv/getting-started/installation/): this is a simple, documented process.
If you are starting a new project, it is recommended to call `uv init --lib` to
initialize the project directory.
Then, you can install usethis for the project:
```console
# With uv
$ uv add --dev usethis
# With pip
$ pip install usethis
```
Alternatively, run in isolation, using `uvx` or `pipx`.
## Interface
### `usethis tool`
Add a new tool to a Python project, including:
- declared & installed dependencies with `uv add`,
- relevant `pyproject.toml` configuration,
- any other relevant directories or tool-bespoke configuration files, and
- `.pre-commit-config.yaml` configuration if using `pre-commit`.
Currently supported tools:
- ruff
- pytest
- deptry
- pre-commit
Example:
`usethis tool ruff`
Supported arguments:
- `--remove` to remove the tool instead of adding it
- `--offline` to disable network access and rely on caches
### `usethis ci`
Add Continuous Integration pipelines to the project.
Currently supported platforms:
- Bitbucket
Example:
`usethis ci bitbucket`.
### `usethis browse pypi`
Dispaly or open the PyPI landing page associated with another project.
Example:
`usethis browse pypi numpy`
Supported arguments:
- `--browser` to open the link in the browser automatically.
## Development
[](https://github.com/astral-sh/uv)
This project is at the early stages of development. If you are interested in contributing,
please ensure you have a corresponsing GitHub Issue open.
## License
usethis is licensed under the MIT license ([LICENSE](https://github.com/nathanjmcdougall/usethis-python/blob/main/LICENSE) or <https://opensource.org/licenses/MIT>)
Unless you explicitly state otherwise, any contribution intentionally submitted for
inclusion in usethis by you, as defined in the Apache License, Version 2.0,
(<https://www.apache.org/licenses/LICENSE-2.0>), shall be licensed under the
MIT license, without any additional terms or conditions.
Raw data
{
"_id": null,
"home_page": null,
"name": "usethis",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "init, project, setup, start, usethis",
"author": null,
"author_email": "Nathan McDougall <nathan.j.mcdougall@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/f7/a6/c2786eab175037d5f8d969862b86538f12207fa543897bcee633505ecc9f/usethis-0.2.0.tar.gz",
"platform": null,
"description": "# usethis\n\nAutomate Python project setup and development tasks that are otherwise performed manually.\n\nInspired by an [**R** package of the same name](https://usethis.r-lib.org/index.html),\nthis package brings a similar experience to the Python ecosystem as a CLI tool.\n\n## Highlights\n\n- First-class support for state-of-the-practice tooling: `uv`, `ruff`, `pytest`, and `pre-commit`.\n- Automatically add and remove tools: declare, install, and configure in one step.\n- Powerful knowledge of how different tools interact and sensible defaults.\n- Get started on a new Python project or a new workflow in seconds.\n\n## Getting Started\n\nFirst, it is strongly recommended you [install the `uv` package manager](https://docs.astral.sh/uv/getting-started/installation/): this is a simple, documented process.\n\nIf you are starting a new project, it is recommended to call `uv init --lib` to\ninitialize the project directory.\n\nThen, you can install usethis for the project:\n\n```console\n# With uv\n$ uv add --dev usethis\n\n# With pip\n$ pip install usethis\n```\n\nAlternatively, run in isolation, using `uvx` or `pipx`.\n\n## Interface\n\n### `usethis tool`\n\nAdd a new tool to a Python project, including:\n\n- declared & installed dependencies with `uv add`,\n- relevant `pyproject.toml` configuration,\n- any other relevant directories or tool-bespoke configuration files, and\n- `.pre-commit-config.yaml` configuration if using `pre-commit`.\n\nCurrently supported tools:\n\n- ruff\n- pytest\n- deptry\n- pre-commit\n\nExample:\n\n`usethis tool ruff`\n\nSupported arguments:\n\n- `--remove` to remove the tool instead of adding it\n- `--offline` to disable network access and rely on caches\n\n### `usethis ci`\n\nAdd Continuous Integration pipelines to the project.\n\nCurrently supported platforms:\n\n- Bitbucket\n\nExample:\n\n`usethis ci bitbucket`.\n\n### `usethis browse pypi`\n\nDispaly or open the PyPI landing page associated with another project.\n\nExample:\n\n`usethis browse pypi numpy`\n\nSupported arguments:\n\n- `--browser` to open the link in the browser automatically.\n\n## Development\n\n[](https://github.com/astral-sh/uv)\n\nThis project is at the early stages of development. If you are interested in contributing,\nplease ensure you have a corresponsing GitHub Issue open.\n\n## License\n\nusethis is licensed under the MIT license ([LICENSE](https://github.com/nathanjmcdougall/usethis-python/blob/main/LICENSE) or <https://opensource.org/licenses/MIT>)\n\nUnless you explicitly state otherwise, any contribution intentionally submitted for\ninclusion in usethis by you, as defined in the Apache License, Version 2.0,\n(<https://www.apache.org/licenses/LICENSE-2.0>), shall be licensed under the\nMIT license, without any additional terms or conditions.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Nathan McDougall Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "Automate Python project setup and development tasks that are otherwise performed manually.",
"version": "0.2.0",
"project_urls": {
"Bug Tracker": "https://github.com/nathanjmcdougall/usethis-python/issues",
"Releases": "https://github.com/nathanjmcdougall/usethis-python/releases",
"Source Code": "https://github.com/nathanjmcdougall/usethis-python",
"source_archive": "https://github.com/nathanjmcdougall/usethis-python/archive/54c3798442b641a5050d7e0a4cc524a0b746f6c7.zip"
},
"split_keywords": [
"init",
" project",
" setup",
" start",
" usethis"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "7886b7874c16d533274636644e02d0823cdba5f1588ff1051287341b65f454d7",
"md5": "12dd87dc2c29e032f49e7bc72e2d329e",
"sha256": "4334244a9e0440dd3bdfad5f4c1da80a777d91735f5482f1013a7d7107cc8b58"
},
"downloads": -1,
"filename": "usethis-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "12dd87dc2c29e032f49e7bc72e2d329e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 24376,
"upload_time": "2024-10-30T23:16:21",
"upload_time_iso_8601": "2024-10-30T23:16:21.617584Z",
"url": "https://files.pythonhosted.org/packages/78/86/b7874c16d533274636644e02d0823cdba5f1588ff1051287341b65f454d7/usethis-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "f7a6c2786eab175037d5f8d969862b86538f12207fa543897bcee633505ecc9f",
"md5": "ee8d3fe702950b8baac318061cbdb2c9",
"sha256": "940cc4bacc801e97cc0612bfb69b798fb67c31239bad1edcaaa06a488839e740"
},
"downloads": -1,
"filename": "usethis-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "ee8d3fe702950b8baac318061cbdb2c9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 54517,
"upload_time": "2024-10-30T23:16:24",
"upload_time_iso_8601": "2024-10-30T23:16:24.939776Z",
"url": "https://files.pythonhosted.org/packages/f7/a6/c2786eab175037d5f8d969862b86538f12207fa543897bcee633505ecc9f/usethis-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-30 23:16:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nathanjmcdougall",
"github_project": "usethis-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "usethis"
}
