# degel-python-utils
Shared Python utilities from Degel Software Ltd.
## Using degel-python-utils
### Initial setup on a new machine
To get started with `degel-python-utils` on a new machine, follow these steps:
1. **Clone the repository:**
```bash
git clone https://github.com/yourusername/degel-python-utils.git
cd degel-python-utils
```
2. **Install dependencies:**
Make sure you have `pipenv` installed. If not, install it using `pip`:
```bash
pip install pipenv
```
Then, install the project dependencies and pre-commit hooks:
```bash
make install
```
### Using degel-python-utils in other projects
To use `degel-python-utils` in other projects, you need to install it via PyPI:
1. **Install the library:**
Add `degel-python-utils` to your `Pipfile` or install it directly using `pipenv`:
```bash
pipenv install degel-python-utils
```
2. **Import and use:**
You can now import and use the utility functions provided by `degel-python-utils` in
your project:
```python
from degel_python_utils import some_function
some_function()
```
### Developing degel-python-utils
If you want to contribute to the development of `degel-python-utils` or make local
modifications, follow these steps:
1. **Clone the repository:**
```bash
git clone https://github.com/yourusername/degel-python-utils.git
cd degel-python-utils
```
2. **Install dependencies and pre-commit hooks:**
```bash
make install
```
4. **Run tests:**
Ensure all tests pass before making changes:
```bash
make test
```
5. **Make your changes:**
Edit the code as needed. Ensure that your code follows the project's coding standards.
6. **Lint and test:**
Before committing your changes, run linting and tests:
```bash
make lint
make test
```
7. **Commit and push:**
Commit your changes and push to your fork or branch:
```bash
git add .
git commit -m "Describe your changes"
git push origin your-branch
```
### Distributing degel-python-utils
To distribute a new version of `degel-python-utils`, follow these steps:
1. **Update version:**
Update the version number in `setup.cfg`.
2. **Build the package:**
Use `build` to create the distribution package:
```bash
make build
```
3. **Upload to PyPI:**
Upload the package to PyPI using `twine`:
```bash
make publish
```
4. **Tag the release:**
Tag the new release in your git repository:
```bash
git tag vX.Y.Z
git push origin vX.Y.Z
```
By following these instructions, you can effectively use, develop, and distribute the
`degel-python-utils` library. If you encounter any issues or have questions, feel free
to open an issue on the GitHub repository.
### License and copyright
This project is licensed under the [MIT License](LICENSE).
Copyright © 2024, Degel Software Ltd.
Raw data
{
"_id": null,
"home_page": "https://github.com/deg/degel-python-utils",
"name": "degel-python-utils",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": null,
"author": "David Goldfarb",
"author_email": "deg@degel.com",
"download_url": "https://files.pythonhosted.org/packages/0a/3c/bd319e4d68a6d052ce232a80306ac24dfbb0e5ffe7af5bf5de306c0540b0/degel_python_utils-0.1.12.tar.gz",
"platform": null,
"description": "# degel-python-utils\n\nShared Python utilities from Degel Software Ltd.\n\n## Using degel-python-utils\n\n### Initial setup on a new machine\n\nTo get started with `degel-python-utils` on a new machine, follow these steps:\n\n1. **Clone the repository:**\n\n ```bash\n git clone https://github.com/yourusername/degel-python-utils.git\n cd degel-python-utils\n ```\n\n2. **Install dependencies:**\n\n Make sure you have `pipenv` installed. If not, install it using `pip`:\n\n ```bash\n pip install pipenv\n ```\n\n Then, install the project dependencies and pre-commit hooks:\n\n ```bash\n make install\n ```\n\n\n### Using degel-python-utils in other projects\n\nTo use `degel-python-utils` in other projects, you need to install it via PyPI:\n\n1. **Install the library:**\n\n Add `degel-python-utils` to your `Pipfile` or install it directly using `pipenv`:\n\n ```bash\n pipenv install degel-python-utils\n ```\n\n2. **Import and use:**\n\n You can now import and use the utility functions provided by `degel-python-utils` in\n your project:\n\n ```python\n from degel_python_utils import some_function\n\n some_function()\n ```\n\n### Developing degel-python-utils\n\nIf you want to contribute to the development of `degel-python-utils` or make local\nmodifications, follow these steps:\n\n1. **Clone the repository:**\n\n ```bash\n git clone https://github.com/yourusername/degel-python-utils.git\n cd degel-python-utils\n ```\n\n2. **Install dependencies and pre-commit hooks:**\n\n ```bash\n make install\n ```\n\n4. **Run tests:**\n\n Ensure all tests pass before making changes:\n\n ```bash\n make test\n ```\n\n5. **Make your changes:**\n\n Edit the code as needed. Ensure that your code follows the project's coding standards.\n\n6. **Lint and test:**\n\n Before committing your changes, run linting and tests:\n\n ```bash\n make lint\n make test\n ```\n\n7. **Commit and push:**\n\n Commit your changes and push to your fork or branch:\n\n ```bash\n git add .\n git commit -m \"Describe your changes\"\n git push origin your-branch\n ```\n\n### Distributing degel-python-utils\n\nTo distribute a new version of `degel-python-utils`, follow these steps:\n\n1. **Update version:**\n\n Update the version number in `setup.cfg`.\n\n2. **Build the package:**\n\n Use `build` to create the distribution package:\n\n ```bash\n make build\n ```\n\n3. **Upload to PyPI:**\n\n Upload the package to PyPI using `twine`:\n\n ```bash\n make publish\n ```\n\n4. **Tag the release:**\n\n Tag the new release in your git repository:\n\n ```bash\n git tag vX.Y.Z\n git push origin vX.Y.Z\n ```\n\nBy following these instructions, you can effectively use, develop, and distribute the\n`degel-python-utils` library. If you encounter any issues or have questions, feel free\nto open an issue on the GitHub repository.\n\n\n### License and copyright\n\nThis project is licensed under the [MIT License](LICENSE).\n\nCopyright © 2024, Degel Software Ltd.\n",
"bugtrack_url": null,
"license": null,
"summary": "Shared Python utilities from Degel Software Ltd.",
"version": "0.1.12",
"project_urls": {
"Homepage": "https://github.com/deg/degel-python-utils"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b939d51dc02e0c9cfd3de7ac2017e89b43412e2bff89b2ee8bba15575dd92bd6",
"md5": "e4ab77a2615a85092b060bc54be1db59",
"sha256": "41f50f3b33fe9f6b4e21fa8eeb3b6647d16b22d447159546288ac457b10da1ee"
},
"downloads": -1,
"filename": "degel_python_utils-0.1.12-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e4ab77a2615a85092b060bc54be1db59",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 15807,
"upload_time": "2024-08-08T19:15:57",
"upload_time_iso_8601": "2024-08-08T19:15:57.132886Z",
"url": "https://files.pythonhosted.org/packages/b9/39/d51dc02e0c9cfd3de7ac2017e89b43412e2bff89b2ee8bba15575dd92bd6/degel_python_utils-0.1.12-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0a3cbd319e4d68a6d052ce232a80306ac24dfbb0e5ffe7af5bf5de306c0540b0",
"md5": "4a4492958ee4892a1c2c0385ed0a0e0d",
"sha256": "4a2d94319d679419b4435bbe910432d2e15aed067515a07bc239e15b6010355b"
},
"downloads": -1,
"filename": "degel_python_utils-0.1.12.tar.gz",
"has_sig": false,
"md5_digest": "4a4492958ee4892a1c2c0385ed0a0e0d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 14005,
"upload_time": "2024-08-08T19:15:58",
"upload_time_iso_8601": "2024-08-08T19:15:58.682081Z",
"url": "https://files.pythonhosted.org/packages/0a/3c/bd319e4d68a6d052ce232a80306ac24dfbb0e5ffe7af5bf5de306c0540b0/degel_python_utils-0.1.12.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-08 19:15:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "deg",
"github_project": "degel-python-utils",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "degel-python-utils"
}
JSON
