pipeline-utils


Namepipeline-utils JSON
Version 0.0.2 PyPI version JSON
download
home_pagehttps://github.com/CoralMapping/proc_pipeline_utils
SummaryUtility functions for Coral Atlas Pipelines
upload_time2020-11-25 18:42:18
maintainer
docs_urlNone
author
requires_python>=3.6
license
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # proc_pipeline_utils
Shared utility functions for Coral Atlas data pipelines

### Authentication
To function properly, this code needs credentials that it can use to authenticate against the Google Earth Engine API. Credentials can be provided in one of two ways, and the code will look for them in this order:

Service Account Key.
Before running this code, create an environment variable named SERVICE_ACCOUNT_KEY containing the JSON key for a Google Cloud service account with the necessary permissions to perform the actions you're trying to perform in GEE.

Personal Credentials.
Before running this code, authenticate with the Google Earth Engine API using the earthengine command line tool:

```
$ earthengine authenticate
```

Remember that authentication is only required if you are planning to give coordinates through earthengine asset as input.

### Development

This project uses [Pipenv](https://docs.pipenv.org/en/latest/) to manage virtual environments and dependencies. Development-time dependencies are documented in the `Pipfile`. Follow the `Pipenv` documentation to create a virtual environment and install the dependencies.

#### Makefile

The included `Makefile` prescribes actions to test, build, and publish this code to a Python Package Index (PyPI) repository as described in the following sections.
```
$ make [test | build | publish]
```

#### Testing

With the virtual environment active and the dependencies installed, use [pytest](https://docs.pytest.org/en/latest/) to run the test suite.

To run the unit tests, run:
```
$ pipenv run pytest
```

#### Building

This project uses the [setuptools](https://packaging.python.org/key_projects/#setuptools) Python package for packaging as described [here](https://packaging.python.org/tutorials/packaging-projects/).

When building via the `make build` command, you may optionally append to the package name using the `prerelease` argument. For example, if the current version of `pipelines_utils` specified in the `setup.py` module is `1.0.1`, then
```
$ make build prerelease=rc1
```
will produce a package named `pipelines_utils-1.0.1rc1`. The default is a beta prerelease name incremented by each git commit (eg/ `1.0.1b7` for the seventh commit on this branch). Specify a final release with
```
$ make build prerelease=""
```

Note that prerelease names must comply with [PEP 440](https://www.python.org/dev/peps/pep-0440/).

#### Publishing
This project uses the [twine](https://packaging.python.org/key_projects/#twine) Python package for distribution as described [here](https://packaging.python.org/tutorials/packaging-projects/).

When publishing via the `make publish` command, the default PyPI repository is [testpypi](https://packaging.python.org/guides/using-testpypi/). To publish to [pypi.org](https://pypi.org), specify that repository:
```
$ make publish pypi_repository=pypi
```

The credentials necessary to publish to the target PyPI repository can be provided in one of two ways.

1. As these environment variables:

| Env Var                      | Notes                                      |
| :--------:                   | ------------------------------------------ |
| `PYPI_REPOSITORY_USERNAME`   | PyPI account username. If authenticating [using a token](https://test.pypi.org/help/#apitoken), use the literal string `__token__`. |
| `PYPI_REPOSITORY_PASSWORD`   | PyPI account password. If authenticating [using a token](https://test.pypi.org/help/#apitoken), use the token contents. |

2. At the `make publish` command:
```
$ make publish pypi_repository=pypi pypi_repository_username="foo" pypi_repository_password="bar"
```


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/CoralMapping/proc_pipeline_utils",
    "name": "pipeline-utils",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "",
    "keywords": "",
    "author": "",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/65/ed/66a6e32e185edc477f2c1be759e283e538936af7d1b7d487ee5b3a31f4c0/pipeline_utils-0.0.2.tar.gz",
    "platform": "",
    "description": "# proc_pipeline_utils\nShared utility functions for Coral Atlas data pipelines\n\n### Authentication\nTo function properly, this code needs credentials that it can use to authenticate against the Google Earth Engine API. Credentials can be provided in one of two ways, and the code will look for them in this order:\n\nService Account Key.\nBefore running this code, create an environment variable named SERVICE_ACCOUNT_KEY containing the JSON key for a Google Cloud service account with the necessary permissions to perform the actions you're trying to perform in GEE.\n\nPersonal Credentials.\nBefore running this code, authenticate with the Google Earth Engine API using the earthengine command line tool:\n\n```\n$ earthengine authenticate\n```\n\nRemember that authentication is only required if you are planning to give coordinates through earthengine asset as input.\n\n### Development\n\nThis project uses [Pipenv](https://docs.pipenv.org/en/latest/) to manage virtual environments and dependencies. Development-time dependencies are documented in the `Pipfile`. Follow the `Pipenv` documentation to create a virtual environment and install the dependencies.\n\n#### Makefile\n\nThe included `Makefile` prescribes actions to test, build, and publish this code to a Python Package Index (PyPI) repository as described in the following sections.\n```\n$ make [test | build | publish]\n```\n\n#### Testing\n\nWith the virtual environment active and the dependencies installed, use [pytest](https://docs.pytest.org/en/latest/) to run the test suite.\n\nTo run the unit tests, run:\n```\n$ pipenv run pytest\n```\n\n#### Building\n\nThis project uses the [setuptools](https://packaging.python.org/key_projects/#setuptools) Python package for packaging as described [here](https://packaging.python.org/tutorials/packaging-projects/).\n\nWhen building via the `make build` command, you may optionally append to the package name using the `prerelease` argument. For example, if the current version of `pipelines_utils` specified in the `setup.py` module is `1.0.1`, then\n```\n$ make build prerelease=rc1\n```\nwill produce a package named `pipelines_utils-1.0.1rc1`. The default is a beta prerelease name incremented by each git commit (eg/ `1.0.1b7` for the seventh commit on this branch). Specify a final release with\n```\n$ make build prerelease=\"\"\n```\n\nNote that prerelease names must comply with [PEP 440](https://www.python.org/dev/peps/pep-0440/).\n\n#### Publishing\nThis project uses the [twine](https://packaging.python.org/key_projects/#twine) Python package for distribution as described [here](https://packaging.python.org/tutorials/packaging-projects/).\n\nWhen publishing via the `make publish` command, the default PyPI repository is [testpypi](https://packaging.python.org/guides/using-testpypi/). To publish to [pypi.org](https://pypi.org), specify that repository:\n```\n$ make publish pypi_repository=pypi\n```\n\nThe credentials necessary to publish to the target PyPI repository can be provided in one of two ways.\n\n1. As these environment variables:\n\n| Env Var                      | Notes                                      |\n| :--------:                   | ------------------------------------------ |\n| `PYPI_REPOSITORY_USERNAME`   | PyPI account username. If authenticating [using a token](https://test.pypi.org/help/#apitoken), use the literal string `__token__`. |\n| `PYPI_REPOSITORY_PASSWORD`   | PyPI account password. If authenticating [using a token](https://test.pypi.org/help/#apitoken), use the token contents. |\n\n2. At the `make publish` command:\n```\n$ make publish pypi_repository=pypi pypi_repository_username=\"foo\" pypi_repository_password=\"bar\"\n```\n\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Utility functions for Coral Atlas Pipelines",
    "version": "0.0.2",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "33edb5588d6b9442ce5a93f9295b440d",
                "sha256": "ef3466f2ef6d354ba1dfda3c3f93323a82d9d54f7e82e8d6287ae1f57de36d45"
            },
            "downloads": -1,
            "filename": "pipeline_utils-0.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "33edb5588d6b9442ce5a93f9295b440d",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 8672,
            "upload_time": "2020-11-25T18:42:17",
            "upload_time_iso_8601": "2020-11-25T18:42:17.056857Z",
            "url": "https://files.pythonhosted.org/packages/64/0b/c8cb35281e1d7d0b27e091c54580b7e59464827a194ec33ee3a0a5078c00/pipeline_utils-0.0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "23f96a6690a20176aa63907a7716c087",
                "sha256": "29c6bf6a69b504fef5e1673092d17cf1399308282f89e4097503687040431f07"
            },
            "downloads": -1,
            "filename": "pipeline_utils-0.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "23f96a6690a20176aa63907a7716c087",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 4182,
            "upload_time": "2020-11-25T18:42:18",
            "upload_time_iso_8601": "2020-11-25T18:42:18.035519Z",
            "url": "https://files.pythonhosted.org/packages/65/ed/66a6e32e185edc477f2c1be759e283e538936af7d1b7d487ee5b3a31f4c0/pipeline_utils-0.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2020-11-25 18:42:18",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": null,
    "github_project": "CoralMapping",
    "error": "Could not fetch GitHub repository",
    "lcname": "pipeline-utils"
}
        
Elapsed time: 0.18587s