| Name | diffify-lib JSON |
| Version |
0.1.3
JSON |
| download |
| home_page | None |
| Summary | Code that is used by the backend and Python APIs for diffify.com |
| upload_time | 2024-06-28 08:41:16 |
| maintainer | None |
| docs_url | None |
| author | Jumping Rivers |
| requires_python | <4.0,>=3.10 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# diffify-lib
## For Developers
### Environment set up
From this directory (`./diffify-lib/` in the repository), to load the developer
environment for this package:
- Install `poetry`: `pip install poetry`
- Install the 'dev' dependencies: `poetry install`
Then activate the environment:
```bash
poetry shell
```
From here you can open VS code, and have the environment preloaded.
## Tests
Unit tests can be run without further set up:
```bash
pytest tests/unit
```
To run the integration tests, you'll need some environment variables defined:
- `S3_KEY_DEV`
- `S3_SECRET_DEV`
- `S3_BUCKET_DEV`
- `S3_URL_DEV`
Contact the diffify devs if you need these secrets. The simplest way to use
these secrets locally is to store them in a file `.dev.env` (do not add this
file to version control) and load that file into your working environment before
running the tests:
```bash
env $(cat .dev.env) pytest tests
```
Note that the integration tests will be run in GitLab's CI runners, so you may
not need to have access to these secrets.
### Version numbers
Any pull request that modifies the source code should have an associated version bump to the
package. When this happens you should change the version in two places:
- `[tool.poetry]` section of `pyproject.toml`
- `__version__` declaration in `diffify_lib/__init__.py`
A simple way to keep the version numbers in sync is to use:
```
poetry version patch|minor|major
```
This requires that `poetry-bumpversion` is installed alongside `poetry`.
### Pre-commit hooks
A pre-commit suite is defined in the root of this repository. You are strongly
advised to use these hooks during development. To register the hooks with your
local copy of the repository, run the following (from the repo-root):
```bash
# Install pre-commit itself
pip install pre-commit
# Install the hooks that pre-commit runs
pre-commit install
```
Now, `pre-commit` will run on your code at every commit, maintaining the style
and quality of the code.
Raw data
{
"_id": null,
"home_page": null,
"name": "diffify-lib",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": null,
"author": "Jumping Rivers",
"author_email": "info@jumpingrivers.com",
"download_url": "https://files.pythonhosted.org/packages/84/54/803eeaa83c6375f4569d92ca857c663f0778f00a214d5ad3e61fee88ca34/diffify_lib-0.1.3.tar.gz",
"platform": null,
"description": "# diffify-lib\n\n## For Developers\n\n### Environment set up\n\nFrom this directory (`./diffify-lib/` in the repository), to load the developer\nenvironment for this package:\n\n- Install `poetry`: `pip install poetry`\n- Install the 'dev' dependencies: `poetry install`\n\nThen activate the environment:\n\n```bash\npoetry shell\n```\n\nFrom here you can open VS code, and have the environment preloaded.\n\n## Tests\n\nUnit tests can be run without further set up:\n\n```bash\npytest tests/unit\n```\n\nTo run the integration tests, you'll need some environment variables defined:\n\n- `S3_KEY_DEV`\n- `S3_SECRET_DEV`\n- `S3_BUCKET_DEV`\n- `S3_URL_DEV`\n\nContact the diffify devs if you need these secrets. The simplest way to use\nthese secrets locally is to store them in a file `.dev.env` (do not add this\nfile to version control) and load that file into your working environment before\nrunning the tests:\n\n```bash\nenv $(cat .dev.env) pytest tests\n```\n\nNote that the integration tests will be run in GitLab's CI runners, so you may\nnot need to have access to these secrets.\n\n### Version numbers\n\nAny pull request that modifies the source code should have an associated version bump to the\npackage. When this happens you should change the version in two places:\n\n- `[tool.poetry]` section of `pyproject.toml`\n- `__version__` declaration in `diffify_lib/__init__.py`\n\nA simple way to keep the version numbers in sync is to use:\n\n```\npoetry version patch|minor|major\n```\n\nThis requires that `poetry-bumpversion` is installed alongside `poetry`.\n\n### Pre-commit hooks\n\nA pre-commit suite is defined in the root of this repository. You are strongly\nadvised to use these hooks during development. To register the hooks with your\nlocal copy of the repository, run the following (from the repo-root):\n\n```bash\n# Install pre-commit itself\npip install pre-commit\n# Install the hooks that pre-commit runs\npre-commit install\n```\n\nNow, `pre-commit` will run on your code at every commit, maintaining the style\nand quality of the code.\n",
"bugtrack_url": null,
"license": null,
"summary": "Code that is used by the backend and Python APIs for diffify.com",
"version": "0.1.3",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b9d52848e952c83c0c003e6e3afe6f1a1bab8c1fa9c6a0788203d7c8e89245cd",
"md5": "c5785ef77443961b77fc633d0ad9b621",
"sha256": "56fb5043fa3d825341fe45aed1c31d89f6a9cf8a43cb3b85e8d7ec2ea9679038"
},
"downloads": -1,
"filename": "diffify_lib-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c5785ef77443961b77fc633d0ad9b621",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 4297,
"upload_time": "2024-06-28T08:41:14",
"upload_time_iso_8601": "2024-06-28T08:41:14.827125Z",
"url": "https://files.pythonhosted.org/packages/b9/d5/2848e952c83c0c003e6e3afe6f1a1bab8c1fa9c6a0788203d7c8e89245cd/diffify_lib-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8454803eeaa83c6375f4569d92ca857c663f0778f00a214d5ad3e61fee88ca34",
"md5": "560e437c7af42288e04fde4dadeae4c9",
"sha256": "163d62c1ea0aa7b8702d815aa55e191047d5d02406af454a2682a85a36fb63bd"
},
"downloads": -1,
"filename": "diffify_lib-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "560e437c7af42288e04fde4dadeae4c9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 3678,
"upload_time": "2024-06-28T08:41:16",
"upload_time_iso_8601": "2024-06-28T08:41:16.245277Z",
"url": "https://files.pythonhosted.org/packages/84/54/803eeaa83c6375f4569d92ca857c663f0778f00a214d5ad3e61fee88ca34/diffify_lib-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-28 08:41:16",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "diffify-lib"
}
