envidat-utils


Nameenvidat-utils JSON
Version 1.4.12 PyPI version JSON
download
home_pageNone
SummaryUtilities in Python for the WSL EnviDat project.
upload_time2025-01-10 12:20:29
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseMIT
keywords envidat s3 ckan wsl
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # EnviDat Python Utils

<div align="center">
  <img src="https://www.envidat.ch/uploads/group/2020-11-04-134216.5237452000px-LogoWSL.svg.png" width="200" style="width: 200px;" alt="WSL"></a>
</div>
<div align="center">
  <em>Utilities for EnviDat projects in Python.</em>
</div>
<div align="center">
  <a href="https://pypi.org/project/envidat-utils" target="_blank">
      <img src="https://img.shields.io/pypi/v/envidat-utils?color=%2334D058&label=pypi%20package" alt="Package version">
  </a>
  <a href="https://pypistats.org/packages/envidat-utils" target="_blank">
      <img src="https://img.shields.io/pypi/dm/envidat-utils.svg" alt="Downloads">
  </a>
  <a href="https://gitlabext.wsl.ch/EnviDat/envidat-python-utils/-/raw/main/LICENCE" target="_blank">
      <img src="https://img.shields.io/github/license/EnviDat/envidat-python-utils.svg" alt="Licence">
  </a>
</div>

---

**Documentation**: <a href="https://envidat.gitlab-pages.wsl.ch/envidat-python-utils/" target="_blank">https://envidat.gitlab-pages.wsl.ch/envidat-python-utils/</a>

**Source Code**: <a href="https://gitlabext.wsl.ch/EnviDat/envidat-python-utils" target="_blank">https://gitlabext.wsl.ch/EnviDat/envidat-python-utils</a>

---

## PyPi Package

- This package aims to speed up EnviDat python workflows
- Contains:
  - Backend API function wrappers.
  - S3 bucket class, with configurable endpoint.
  - Utils to use in multiple projects (e.g. consistent logger setup).

## Install

```bash
$ pip install -U pip
$ pip install envidat-utils
```

## Usage

```python
from envidat.utils import get_logger
from envidat.s3 import Bucket
from envidat.api.v1 import get_package_list
```

## Config

Environment variables:

- LOG_LEVEL: Logging level, default INFO
- DOTENV_PATH: Path to dotenv file if in debug mode, default=.env.
- API_URL: URL root for the API to call, default=https://www.envidat.ch
- TEMP_DIR: Temporary path for S3 downloads, default=/tmp
- AWS_ENDPOINT: For S3.
- AWS_REGION: For S3.
- AWS_ACCESS_KEY: For S3.
- AWS_SECRET_KEY: For S3.


            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "envidat-utils",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "envidat, s3, ckan, wsl",
    "author": null,
    "author_email": "Sam Woodcock <samuel.woodcock@wsl.ch>,Rebecca Kurup Buchholz <rebecca.kurup@wsl.ch>,Ranita Pal <ranita.pal@wsl.ch>",
    "download_url": "https://files.pythonhosted.org/packages/f3/30/21f9598e148dd572afacdf95caecc9c4f48b006252c98a9e1b1f6f17722a/envidat-utils-1.4.12.tar.gz",
    "platform": null,
    "description": "# EnviDat Python Utils\n\n<div align=\"center\">\n  <img src=\"https://www.envidat.ch/uploads/group/2020-11-04-134216.5237452000px-LogoWSL.svg.png\" width=\"200\" style=\"width: 200px;\" alt=\"WSL\"></a>\n</div>\n<div align=\"center\">\n  <em>Utilities for EnviDat projects in Python.</em>\n</div>\n<div align=\"center\">\n  <a href=\"https://pypi.org/project/envidat-utils\" target=\"_blank\">\n      <img src=\"https://img.shields.io/pypi/v/envidat-utils?color=%2334D058&label=pypi%20package\" alt=\"Package version\">\n  </a>\n  <a href=\"https://pypistats.org/packages/envidat-utils\" target=\"_blank\">\n      <img src=\"https://img.shields.io/pypi/dm/envidat-utils.svg\" alt=\"Downloads\">\n  </a>\n  <a href=\"https://gitlabext.wsl.ch/EnviDat/envidat-python-utils/-/raw/main/LICENCE\" target=\"_blank\">\n      <img src=\"https://img.shields.io/github/license/EnviDat/envidat-python-utils.svg\" alt=\"Licence\">\n  </a>\n</div>\n\n---\n\n**Documentation**: <a href=\"https://envidat.gitlab-pages.wsl.ch/envidat-python-utils/\" target=\"_blank\">https://envidat.gitlab-pages.wsl.ch/envidat-python-utils/</a>\n\n**Source Code**: <a href=\"https://gitlabext.wsl.ch/EnviDat/envidat-python-utils\" target=\"_blank\">https://gitlabext.wsl.ch/EnviDat/envidat-python-utils</a>\n\n---\n\n## PyPi Package\n\n- This package aims to speed up EnviDat python workflows\n- Contains:\n  - Backend API function wrappers.\n  - S3 bucket class, with configurable endpoint.\n  - Utils to use in multiple projects (e.g. consistent logger setup).\n\n## Install\n\n```bash\n$ pip install -U pip\n$ pip install envidat-utils\n```\n\n## Usage\n\n```python\nfrom envidat.utils import get_logger\nfrom envidat.s3 import Bucket\nfrom envidat.api.v1 import get_package_list\n```\n\n## Config\n\nEnvironment variables:\n\n- LOG_LEVEL: Logging level, default INFO\n- DOTENV_PATH: Path to dotenv file if in debug mode, default=.env.\n- API_URL: URL root for the API to call, default=https://www.envidat.ch\n- TEMP_DIR: Temporary path for S3 downloads, default=/tmp\n- AWS_ENDPOINT: For S3.\n- AWS_REGION: For S3.\n- AWS_ACCESS_KEY: For S3.\n- AWS_SECRET_KEY: For S3.\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Utilities in Python for the WSL EnviDat project.",
    "version": "1.4.12",
    "project_urls": {
        "documentation": "https://envidat.gitlab-pages.wsl.ch/envidat-python-utils",
        "homepage": "https://www.envidat.ch",
        "repository": "https://gitlabext.wsl.ch/EnviDat/envidat-python-utils.git"
    },
    "split_keywords": [
        "envidat",
        " s3",
        " ckan",
        " wsl"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e6ba64423c30af3a34ef0e0fde6aacd9c08463ac49659df88e292176f3cd1280",
                "md5": "526b28c8066950a1eb65b491d6323217",
                "sha256": "e210d746a25c479dd9b909eab6aba7215badb56e64021588fd936bcd8f7e1e09"
            },
            "downloads": -1,
            "filename": "envidat_utils-1.4.12-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "526b28c8066950a1eb65b491d6323217",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 134513,
            "upload_time": "2025-01-10T12:20:28",
            "upload_time_iso_8601": "2025-01-10T12:20:28.377182Z",
            "url": "https://files.pythonhosted.org/packages/e6/ba/64423c30af3a34ef0e0fde6aacd9c08463ac49659df88e292176f3cd1280/envidat_utils-1.4.12-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f33021f9598e148dd572afacdf95caecc9c4f48b006252c98a9e1b1f6f17722a",
                "md5": "3766b88f6b58e60ec9f8b8555051fbe8",
                "sha256": "ea3a1e132eea0f57217477ca8c90c7e1a4cc8c520a4de2b0754013acb301dd97"
            },
            "downloads": -1,
            "filename": "envidat-utils-1.4.12.tar.gz",
            "has_sig": false,
            "md5_digest": "3766b88f6b58e60ec9f8b8555051fbe8",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 141833,
            "upload_time": "2025-01-10T12:20:29",
            "upload_time_iso_8601": "2025-01-10T12:20:29.677194Z",
            "url": "https://files.pythonhosted.org/packages/f3/30/21f9598e148dd572afacdf95caecc9c4f48b006252c98a9e1b1f6f17722a/envidat-utils-1.4.12.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-10 12:20:29",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "envidat-utils"
}
        
Elapsed time: 1.81201s