| Name | deltares_datasuite JSON |
| Version |
0.5.0
JSON |
| download |
| home_page | https://datasuite.deltares.nl |
| Summary | Python package to create and update STAC items in the Deltares Data Management Suite |
| upload_time | 2024-04-09 09:40:12 |
| maintainer | Deltares |
| docs_url | None |
| author | Deltares |
| requires_python | <3.12,>=3.9 |
| license | MIT |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# deltares_datasuite
<div align="center">
[](https://github.com/Deltares-research/data-management-suite/actions/workflows/python-package.yml)
[](https://pypi.org/project/deltares_datasuite/)
[](https://github.com/Deltares-research/data-management-suite/pulls?utf8=%E2%9C%93&q=is%3Apr%20author%3Aapp%2Fdependabot)
[](https://github.com/psf/black)
[](https://github.com/PyCQA/bandit)
[](https://github.com/Deltares-research/data-management-suite/blob/master/.pre-commit-config.yaml)
[](https://github.com/Deltares-research/data-management-suite/releases)
Python package to easily work with STAC items in the Deltares Data Management Suite
</div>
## Installation
```bash
pip install -U deltares_datasuite
```
or install with `Poetry`
```bash
poetry add deltares_datasuite
```
## Development
### Deployment features
- `GitHub` integration: issue and pr templates.
- `Github Actions` with predefined [build workflow](https://github.com/Deltares-research/data-management-suite/blob/master/.github/workflows/build.yml) as the default CI/CD.
- Everything is already set up for security checks, codestyle checks, code formatting, testing, linting, docker builds, etc with [`Makefile`](https://github.com/Deltares-research/data-management-suite/blob/master/Makefile#L89). More details in [makefile-usage](#makefile-usage).
- [Dockerfile](https://github.com/Deltares-research/data-management-suite/blob/master/docker/Dockerfile) for your package.
- Always up-to-date dependencies with [`@dependabot`](https://dependabot.com/). You will only [enable it](https://docs.github.com/en/github/administering-a-repository/enabling-and-disabling-version-updates#enabling-github-dependabot-version-updates).
- Automatic drafts of new releases with [`Release Drafter`](https://github.com/marketplace/actions/release-drafter). You may see the list of labels in [`release-drafter.yml`](https://github.com/Deltares-research/data-management-suite/blob/master/.github/release-drafter.yml). Works perfectly with [Semantic Versions](https://semver.org/) specification.
### Open source community features
- Ready-to-use [Pull Requests templates](https://github.com/Deltares-research/data-management-suite/blob/master/.github/PULL_REQUEST_TEMPLATE.md) and several [Issue templates](https://github.com/Deltares-research/data-management-suite/tree/master/.github/ISSUE_TEMPLATE).
- Files such as: `LICENSE`, `CONTRIBUTING.md`, `CODE_OF_CONDUCT.md`, and `SECURITY.md` are generated automatically.
- [`Stale bot`](https://github.com/apps/stale) that closes abandoned issues after a period of inactivity. (You will only [need to setup free plan](https://github.com/marketplace/stale)). Configuration is [here](https://github.com/Deltares-research/data-management-suite/blob/master/.github/.stale.yml).
- [Semantic Versions](https://semver.org/) specification with [`Release Please`](https://github.com/google-github-actions/release-please-action).
### Makefile usage
[`Makefile`](https://github.com/Deltares-research/data-management-suite/blob/master/Makefile) contains a lot of functions for faster development.
<details>
<summary>1. Download and remove Poetry</summary>
<p>
To download and install Poetry run:
```bash
make poetry-download
```
To uninstall
```bash
make poetry-remove
```
</p>
</details>
<details>
<summary>2. Install all dependencies and pre-commit hooks</summary>
<p>
Install requirements:
```bash
make install
```
Pre-commit hooks coulb be installed after `git init` via
```bash
make pre-commit-install
```
</p>
</details>
<details>
<summary>3. Codestyle</summary>
<p>
Automatic formatting uses `pyupgrade`, `isort` and `black`.
```bash
make codestyle
# or use synonym
make formatting
```
Codestyle checks only, without rewriting files:
```bash
make check-codestyle
```
> Note: `check-codestyle` uses `isort`, `black` and `darglint` library
Update all dev libraries to the latest version using one comand
```bash
make update-dev-deps
```
<details>
<summary>4. Code security</summary>
<p>
```bash
make check-safety
```
This command launches `Poetry` integrity checks as well as identifies security issues with `Safety` and `Bandit`.
```bash
make check-safety
```
</p>
</details>
</p>
</details>
<details>
<summary>5. Type checks</summary>
<p>
Run `mypy` static type checker
```bash
make mypy
```
</p>
</details>
<details>
<summary>6. Tests with coverage badges</summary>
<p>
Run `pytest`
```bash
make test
```
</p>
</details>
<details>
<summary>7. All linters</summary>
<p>
Of course there is a command to ~~rule~~ run all linters in one:
```bash
make lint
```
the same as:
```bash
make test && make check-codestyle && make mypy && make check-safety
```
</p>
</details>
<details>
<summary>8. Docker</summary>
<p>
```bash
make docker-build
```
which is equivalent to:
```bash
make docker-build VERSION=latest
```
Remove docker image with
```bash
make docker-remove
```
More information [about docker](https://github.com/Deltares-research/data-management-suite/tree/master/docker).
</p>
</details>
<details>
<summary>9. Cleanup</summary>
<p>
Delete pycache files
```bash
make pycache-remove
```
Remove package build
```bash
make build-remove
```
Delete .DS_STORE files
```bash
make dsstore-remove
```
Remove .mypycache
```bash
make mypycache-remove
```
Or to remove all above run:
```bash
make cleanup
```
</p>
</details>
## 📈 Releases
You can see the list of available releases on the [GitHub Releases](https://github.com/Deltares-research/data-management-suite/releases) page.
We follow [Semantic Versions](https://semver.org/) specification.
We use [`Release Please`](https://github.com/google-github-actions/release-please-action). As pull requests are merged, a release Pull Request is kept up-to-date listing the changes, ready to publish when you’re ready. With the categories option, you can categorize pull requests in release notes using labels.
<!-- ### List of labels and corresponding titles
| **Label** | **Title in Releases** |
| :-----------------------------------: | :---------------------: |
| `enhancement`, `feature` | 🚀 Features |
| `bug`, `refactoring`, `bugfix`, `fix` | 🔧 Fixes & Refactoring |
| `build`, `ci`, `testing` | 📦 Build System & CI/CD |
| `breaking` | 💥 Breaking Changes |
| `documentation` | 📝 Documentation |
| `dependencies` | ⬆️ Dependencies updates |
You can update it in [`release-drafter.yml`](https://github.com/Deltares-research/data-management-suite/blob/master/.github/release-drafter.yml).
GitHub creates the `bug`, `enhancement`, and `documentation` labels for you. Dependabot creates the `dependencies` label. Create the remaining labels on the Issues tab of your GitHub repository, when you need them. -->
## 🛡 License
<!-- [](https://github.com/Deltares-research/data-management-suite/blob/main/utils/deltares_datasuite/LICENSE) -->
This project is licensed under the terms of the `MIT` license. See [LICENSE](https://github.com/Deltares-research/data-management-suite/blob/main/utils/deltares_datasuite/LICENSE) for more details.
Raw data
{
"_id": null,
"home_page": "https://datasuite.deltares.nl",
"name": "deltares_datasuite",
"maintainer": "Deltares",
"docs_url": null,
"requires_python": "<3.12,>=3.9",
"maintainer_email": "nathan.clerks@deltares.nl",
"keywords": null,
"author": "Deltares",
"author_email": "nathan.clerks@deltares.nl",
"download_url": "https://files.pythonhosted.org/packages/a4/2b/70db3e93fd5cb03c155f9ca6123a71136b44794addb76ced936da109351b/deltares_datasuite-0.5.0.tar.gz",
"platform": null,
"description": "# deltares_datasuite\n\n<div align=\"center\">\n\n[](https://github.com/Deltares-research/data-management-suite/actions/workflows/python-package.yml)\n\n[](https://pypi.org/project/deltares_datasuite/)\n[](https://github.com/Deltares-research/data-management-suite/pulls?utf8=%E2%9C%93&q=is%3Apr%20author%3Aapp%2Fdependabot)\n\n[](https://github.com/psf/black)\n[](https://github.com/PyCQA/bandit)\n[](https://github.com/Deltares-research/data-management-suite/blob/master/.pre-commit-config.yaml)\n[](https://github.com/Deltares-research/data-management-suite/releases)\n\n\nPython package to easily work with STAC items in the Deltares Data Management Suite\n\n</div>\n\n## Installation\n\n```bash\npip install -U deltares_datasuite\n```\n\nor install with `Poetry`\n\n```bash\npoetry add deltares_datasuite\n```\n\n## Development\n\n### Deployment features\n\n- `GitHub` integration: issue and pr templates.\n- `Github Actions` with predefined [build workflow](https://github.com/Deltares-research/data-management-suite/blob/master/.github/workflows/build.yml) as the default CI/CD.\n- Everything is already set up for security checks, codestyle checks, code formatting, testing, linting, docker builds, etc with [`Makefile`](https://github.com/Deltares-research/data-management-suite/blob/master/Makefile#L89). More details in [makefile-usage](#makefile-usage).\n- [Dockerfile](https://github.com/Deltares-research/data-management-suite/blob/master/docker/Dockerfile) for your package.\n- Always up-to-date dependencies with [`@dependabot`](https://dependabot.com/). You will only [enable it](https://docs.github.com/en/github/administering-a-repository/enabling-and-disabling-version-updates#enabling-github-dependabot-version-updates).\n- Automatic drafts of new releases with [`Release Drafter`](https://github.com/marketplace/actions/release-drafter). You may see the list of labels in [`release-drafter.yml`](https://github.com/Deltares-research/data-management-suite/blob/master/.github/release-drafter.yml). Works perfectly with [Semantic Versions](https://semver.org/) specification.\n\n### Open source community features\n\n- Ready-to-use [Pull Requests templates](https://github.com/Deltares-research/data-management-suite/blob/master/.github/PULL_REQUEST_TEMPLATE.md) and several [Issue templates](https://github.com/Deltares-research/data-management-suite/tree/master/.github/ISSUE_TEMPLATE).\n- Files such as: `LICENSE`, `CONTRIBUTING.md`, `CODE_OF_CONDUCT.md`, and `SECURITY.md` are generated automatically.\n- [`Stale bot`](https://github.com/apps/stale) that closes abandoned issues after a period of inactivity. (You will only [need to setup free plan](https://github.com/marketplace/stale)). Configuration is [here](https://github.com/Deltares-research/data-management-suite/blob/master/.github/.stale.yml).\n- [Semantic Versions](https://semver.org/) specification with [`Release Please`](https://github.com/google-github-actions/release-please-action).\n\n### Makefile usage\n\n[`Makefile`](https://github.com/Deltares-research/data-management-suite/blob/master/Makefile) contains a lot of functions for faster development.\n\n<details>\n<summary>1. Download and remove Poetry</summary>\n<p>\n\nTo download and install Poetry run:\n\n```bash\nmake poetry-download\n```\n\nTo uninstall\n\n```bash\nmake poetry-remove\n```\n\n</p>\n</details>\n\n<details>\n<summary>2. Install all dependencies and pre-commit hooks</summary>\n<p>\n\nInstall requirements:\n\n```bash\nmake install\n```\n\nPre-commit hooks coulb be installed after `git init` via\n\n```bash\nmake pre-commit-install\n```\n\n</p>\n</details>\n\n<details>\n<summary>3. Codestyle</summary>\n<p>\n\nAutomatic formatting uses `pyupgrade`, `isort` and `black`.\n\n```bash\nmake codestyle\n\n# or use synonym\nmake formatting\n```\n\nCodestyle checks only, without rewriting files:\n\n```bash\nmake check-codestyle\n```\n\n> Note: `check-codestyle` uses `isort`, `black` and `darglint` library\n\nUpdate all dev libraries to the latest version using one comand\n\n```bash\nmake update-dev-deps\n```\n\n<details>\n<summary>4. Code security</summary>\n<p>\n\n```bash\nmake check-safety\n```\n\nThis command launches `Poetry` integrity checks as well as identifies security issues with `Safety` and `Bandit`.\n\n```bash\nmake check-safety\n```\n\n</p>\n</details>\n\n</p>\n</details>\n\n<details>\n<summary>5. Type checks</summary>\n<p>\n\nRun `mypy` static type checker\n\n```bash\nmake mypy\n```\n\n</p>\n</details>\n\n<details>\n<summary>6. Tests with coverage badges</summary>\n<p>\n\nRun `pytest`\n\n```bash\nmake test\n```\n\n</p>\n</details>\n\n<details>\n<summary>7. All linters</summary>\n<p>\n\nOf course there is a command to ~~rule~~ run all linters in one:\n\n```bash\nmake lint\n```\n\nthe same as:\n\n```bash\nmake test && make check-codestyle && make mypy && make check-safety\n```\n\n</p>\n</details>\n\n<details>\n<summary>8. Docker</summary>\n<p>\n\n```bash\nmake docker-build\n```\n\nwhich is equivalent to:\n\n```bash\nmake docker-build VERSION=latest\n```\n\nRemove docker image with\n\n```bash\nmake docker-remove\n```\n\nMore information [about docker](https://github.com/Deltares-research/data-management-suite/tree/master/docker).\n\n</p>\n</details>\n\n<details>\n<summary>9. Cleanup</summary>\n<p>\nDelete pycache files\n\n```bash\nmake pycache-remove\n```\n\nRemove package build\n\n```bash\nmake build-remove\n```\n\nDelete .DS_STORE files\n\n```bash\nmake dsstore-remove\n```\n\nRemove .mypycache\n\n```bash\nmake mypycache-remove\n```\n\nOr to remove all above run:\n\n```bash\nmake cleanup\n```\n\n</p>\n</details>\n\n## \ud83d\udcc8 Releases\n\nYou can see the list of available releases on the [GitHub Releases](https://github.com/Deltares-research/data-management-suite/releases) page.\n\nWe follow [Semantic Versions](https://semver.org/) specification.\n\nWe use [`Release Please`](https://github.com/google-github-actions/release-please-action). As pull requests are merged, a release Pull Request is kept up-to-date listing the changes, ready to publish when you\u2019re ready. With the categories option, you can categorize pull requests in release notes using labels.\n\n<!-- ### List of labels and corresponding titles\n\n| **Label** | **Title in Releases** |\n| :-----------------------------------: | :---------------------: |\n| `enhancement`, `feature` | \ud83d\ude80 Features |\n| `bug`, `refactoring`, `bugfix`, `fix` | \ud83d\udd27 Fixes & Refactoring |\n| `build`, `ci`, `testing` | \ud83d\udce6 Build System & CI/CD |\n| `breaking` | \ud83d\udca5 Breaking Changes |\n| `documentation` | \ud83d\udcdd Documentation |\n| `dependencies` | \u2b06\ufe0f Dependencies updates |\n\nYou can update it in [`release-drafter.yml`](https://github.com/Deltares-research/data-management-suite/blob/master/.github/release-drafter.yml).\n\nGitHub creates the `bug`, `enhancement`, and `documentation` labels for you. Dependabot creates the `dependencies` label. Create the remaining labels on the Issues tab of your GitHub repository, when you need them. -->\n\n## \ud83d\udee1 License\n\n<!-- [](https://github.com/Deltares-research/data-management-suite/blob/main/utils/deltares_datasuite/LICENSE) -->\n\nThis project is licensed under the terms of the `MIT` license. See [LICENSE](https://github.com/Deltares-research/data-management-suite/blob/main/utils/deltares_datasuite/LICENSE) for more details.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python package to create and update STAC items in the Deltares Data Management Suite",
"version": "0.5.0",
"project_urls": {
"Documentation": "https://datasuite.deltares.nl/docs",
"Homepage": "https://datasuite.deltares.nl",
"Repository": "https://github.com/Deltares-research/data-management-suite"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2610ad3c3e2f23e69fc283b21d339af338031c2ba20c4d0b33c0a0f73c6de00c",
"md5": "aa622e0a5805432072d0ab53cfbb9071",
"sha256": "6115531f3b3a66b78e4812d182497e7ea097d56dafbd8ed97aae2753180712dd"
},
"downloads": -1,
"filename": "deltares_datasuite-0.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "aa622e0a5805432072d0ab53cfbb9071",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.12,>=3.9",
"size": 9356,
"upload_time": "2024-04-09T09:40:11",
"upload_time_iso_8601": "2024-04-09T09:40:11.710168Z",
"url": "https://files.pythonhosted.org/packages/26/10/ad3c3e2f23e69fc283b21d339af338031c2ba20c4d0b33c0a0f73c6de00c/deltares_datasuite-0.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a42b70db3e93fd5cb03c155f9ca6123a71136b44794addb76ced936da109351b",
"md5": "c183c58cec0161563caccef38b9ac7ac",
"sha256": "b40522c655ec780071e2189a406c6a68c92fa43af03e82f74b7cf0fe20b19a76"
},
"downloads": -1,
"filename": "deltares_datasuite-0.5.0.tar.gz",
"has_sig": false,
"md5_digest": "c183c58cec0161563caccef38b9ac7ac",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.12,>=3.9",
"size": 11269,
"upload_time": "2024-04-09T09:40:12",
"upload_time_iso_8601": "2024-04-09T09:40:12.736275Z",
"url": "https://files.pythonhosted.org/packages/a4/2b/70db3e93fd5cb03c155f9ca6123a71136b44794addb76ced936da109351b/deltares_datasuite-0.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-09 09:40:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Deltares-research",
"github_project": "data-management-suite",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "deltares_datasuite"
}
