Pennsieve Python client (pennsieve2)
================
[](https://pypi.org/project/pennsieve2/)
[](https://pypi.org/project/pennsieve2/)
[](https://pypi.org/project/pennsieve2/)
[](https://github.com/Pennsieve/pennsieve-agent-python/blob/main/LICENSE)
[](https://codecov.io/gh/pennsieve/pennsieve-agent-python)
Python client and command line tool for Pennsieve (pennsieve2).
Prerequisites
-------------
In order to use this Python library to upload files to Pennsieve, please follow the instruction on installing and setting up Pennsieve agent, which could be found in the documentation.
Installation
------------
To install, run:
```bash
pip install -U pennsieve2
```
To install specific previous dev version, run:
```bash
pip install -U pennsieve2==0.1.0.dev2 --extra-index-url https://test.pypi.org/simple
```
Contributions
--------------
To update gRPC python files, execute from the src folder:
```bash
rm src/pennsieve2/protos/agent_pb2*
cd src
python3.9 -m grpc_tools.protoc --python_out=. -I. --grpc_python_out=. pennsieve2/protos/agent.proto
```
Notice, this command does not produce a valid agent_pb2.py file when executed for Python3.10 or formatted by black - it does not use reflection and is reported as error for Flake8.
To create a package and upload it to PyPI, first update the package version in the pennsieve2/__init__.py, then execute:
```bash
python -m build
# For testing:
twine upload -r testpypi dist/*
# For production:
twine upload dist/*
```
Documentation
-------------
Client and command line documentation can be found on [Pennsieve’s documentation website](https://docs.pennsieve.io/docs/uploading-files-programmatically).
Development
-------------
This project uses [Poetry](https://python-poetry.org/) to manage dependencies in `pyproject.toml`. To set up a development environment run
```bash
poetry install
```
from the root directory to install the projects dependencies. Some IDEs (IntelliJ Idea for example) can create a Poetry Python
environment as well.
Raw data
{
"_id": null,
"home_page": "",
"name": "pennsieve2",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "data science,datasets",
"author": "Patryk Orzechowski",
"author_email": "patryk@upenn.edu",
"download_url": "https://files.pythonhosted.org/packages/d9/5f/c9e9e92c8ad796ab5dea68e998c9c77780c16847e193d0d0603d48341c51/pennsieve2-0.1.2.tar.gz",
"platform": null,
"description": "Pennsieve Python client (pennsieve2)\n================\n[](https://pypi.org/project/pennsieve2/)\n[](https://pypi.org/project/pennsieve2/)\n[](https://pypi.org/project/pennsieve2/)\n[](https://github.com/Pennsieve/pennsieve-agent-python/blob/main/LICENSE)\n[](https://codecov.io/gh/pennsieve/pennsieve-agent-python)\n\nPython client and command line tool for Pennsieve (pennsieve2).\n\n\nPrerequisites\n-------------\nIn order to use this Python library to upload files to Pennsieve, please follow the instruction on installing and setting up Pennsieve agent, which could be found in the documentation.\n\n\nInstallation\n------------\n\nTo install, run:\n\n```bash\n pip install -U pennsieve2\n```\n\nTo install specific previous dev version, run:\n```bash\n pip install -U pennsieve2==0.1.0.dev2 --extra-index-url https://test.pypi.org/simple\n```\n\nContributions\n--------------\n\nTo update gRPC python files, execute from the src folder:\n\n```bash\n rm src/pennsieve2/protos/agent_pb2*\n cd src\n python3.9 -m grpc_tools.protoc --python_out=. -I. --grpc_python_out=. pennsieve2/protos/agent.proto\n```\nNotice, this command does not produce a valid agent_pb2.py file when executed for Python3.10 or formatted by black - it does not use reflection and is reported as error for Flake8.\n\n\nTo create a package and upload it to PyPI, first update the package version in the pennsieve2/__init__.py, then execute:\n\n```bash\n python -m build\n # For testing:\n twine upload -r testpypi dist/*\n # For production:\n twine upload dist/*\n```\n\nDocumentation\n-------------\n\nClient and command line documentation can be found on [Pennsieve\u2019s documentation website](https://docs.pennsieve.io/docs/uploading-files-programmatically).\n\nDevelopment\n-------------\n\nThis project uses [Poetry](https://python-poetry.org/) to manage dependencies in `pyproject.toml`. To set up a development environment run\n```bash\n poetry install\n```\nfrom the root directory to install the projects dependencies. Some IDEs (IntelliJ Idea for example) can create a Poetry Python\nenvironment as well.\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Pennsieve Python Client",
"version": "0.1.2",
"split_keywords": [
"data science",
"datasets"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e1ac07666cc901d126700e24dcca8de415e6b9d62fdc65fb479ce427c0c5a55c",
"md5": "621bb927fbde8adee01d75ac692b2a05",
"sha256": "b9b4c2ce0606e990470d786b4cb112ccd8bd9a22b94672e9e0ac4348f104b8ca"
},
"downloads": -1,
"filename": "pennsieve2-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "621bb927fbde8adee01d75ac692b2a05",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 27721,
"upload_time": "2023-01-30T20:27:55",
"upload_time_iso_8601": "2023-01-30T20:27:55.468859Z",
"url": "https://files.pythonhosted.org/packages/e1/ac/07666cc901d126700e24dcca8de415e6b9d62fdc65fb479ce427c0c5a55c/pennsieve2-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d95fc9e9e92c8ad796ab5dea68e998c9c77780c16847e193d0d0603d48341c51",
"md5": "c2cc61c26e815de08cbcbb109faba2f4",
"sha256": "3c886dd2c429c63c8e1076bb214dc9b6ab44de19974005b0f98c52833235fa8c"
},
"downloads": -1,
"filename": "pennsieve2-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "c2cc61c26e815de08cbcbb109faba2f4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 25180,
"upload_time": "2023-01-30T20:27:57",
"upload_time_iso_8601": "2023-01-30T20:27:57.517704Z",
"url": "https://files.pythonhosted.org/packages/d9/5f/c9e9e92c8ad796ab5dea68e998c9c77780c16847e193d0d0603d48341c51/pennsieve2-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-30 20:27:57",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "pennsieve2"
}
JSON