معرفی شرکت ها
data-loader-plugin-0.0.1.post1
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
Python plugin/extra to load data files from an external source (such as AWS S3) to a local directory
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | data-loader-plugin-0.0.1.post1 |
| نام | data-loader-plugin |
| نسخه کتابخانه | 0.0.1.post1 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | Stanislav Khrapov |
| ایمیل نویسنده | khrapovs@gmail.com |
| آدرس صفحه اصلی | https://github.com/cloud-helpers/python-plugin-data-loader |
| آدرس اینترنتی | https://pypi.org/project/data-loader-plugin/ |
| مجوز | MIT |
Data Loader Plugin - Python
===========================
# Table of Content (ToC)
- [Data Loader Plugin - Python](#data-loader-plugin-python)
- [Table of Content (ToC)](#table-of-content-toc)
- [Overview](#overview)
- [References](#references)
* [Python module](#python-module)
* [Python virtual environments](#python-virtual-environments)
- [Installation](#installation)
* [Clone this Git repository](#clone-this-git-repository)
* [Python environment](#python-environment)
- [Usage](#usage)
* [Install the `data-loader-plugin` module](#install-the-data-loader-plugin-module)
+ [Install in the Python user space](#install-in-the-python-user-space)
+ [Installation in a dedicated Python virtual environment](#installation-in-a-dedicated-python-virtual-environment)
* [Use `data-loader-plugin` as a module from another Python program](#use-data-loader-plugin-as-a-module-from-another-python-program)
- [Development / Contribution](#development-contribution)
* [Test the data loader plugin Python module](#test-the-data-loader-plugin-python-module)
<small><i><a href='http://ecotrust-canada.github.io/markdown-toc/'>Table of contents generated with markdown-toc</a></i></small>
# Overview
The
[data loader plugin](https://github.com/cloud-helpers/python-plugin-data-loader),
aims at supporting running programs (_e.g._, API service backends) when
downloading data from cloud services such as
[AWS S3](https://aws.amazon.com/s3). It provides a base Python library,
namely `data-loader-plugin`,
offering a few methods to download data files from AWS S3.
# References
## Python module
* GitHub:
https://github.com/cloud-helpers/python-plugin-data-loader/tree/master/data_loader_plugin
* PyPi: https://pypi.org/project/data-loader-plugin/
* Read the Docs (RTD):
https://readthedocs.org/projects/data-loader-plugin/
## Python virtual environments
* Pyenv and pipenv:
http://github.com/machine-learning-helpers/induction-python/tree/master/installation/virtual-env
# Installation
## Clone this Git repository
```bash
$ mkdir -p ~/dev/infra && \
git clone git@github.com:cloud-helpers/python-plugin-data-loader.git ~/dev/infra/python-plugin-data-loader
$ cd ~/dev/infra/python-plugin-data-loader
```
## Python environment
* If not already done so, install `pyenv`, Python 3.9 and, `pip` and `pipenv`
+ PyEnv:
```bash
$ git clone https://github.com/pyenv/pyenv.git ${HOME}/.pyenv
$ cat >> ~/.profile2 << _EOF
# Python
eval "\$(pyenv init --path)"
_EOF
$ cat >> ~/.bashrc << _EOF
# Python
export PYENV_ROOT="\${HOME}/.pyenv"
export PATH="\${PYENV_ROOT}/bin:\${PATH}"
. ~/.profile2
if command -v pyenv 1>/dev/null 2>&1
then
eval "\$(pyenv init -)"
fi
if command -v pipenv 1>/dev/null 2>&1
then
eval "\$(pipenv --completion)"
fi
_EOF
$ . ~/.bashrc
```
+ Python 3.9:
```bash
$ pyenv install 3.9.8 && pyenv local 3.9.8
```
+ `pip`:
```bash
$ python -mpip install -U pip
```
+ `pipenv`:
```bash
$ python -mpip install -U pipenv
```
# Usage
## Install the `data-loader-plugin` module
* There are at least two ways to install the `data-loader-plugin` module,
in the Python user space with `pip` and in a dedicated virtual environment
with `pipenv`.
+ Both options may be installed in parallel
+ The Python user space (typically, `/usr/local/opt/python@3.9` on MacOS
or `~/.pyenv/versions/3.9.8` on Linux) may already have many other modules
installed, parasiting a fine-grained control over the versions of every
Python dependency. If all the versions are compatible, then that option
is convenient as it is available from the whole user space, not just
from this sub-directory
* In the remainder of that [Usage section](#usage), it will be assumed
that the `data-loader-plugin` module has been installed and readily
available from the environment, whether that environment is virtual
or not.
In other words, to adapt the documentation for the case where `pipenv`
is used, just add `pipenv run` in front of every Python-related command.
### Install in the Python user space
* Install and use the `data-loader-plugin` module in the user space
(with `pip`):
```bash
$ python -mpip uninstall data-loader-plugin
$ python -mpip install -U data-loader-plugin
```
### Installation in a dedicated Python virtual environment
* Install and use the `data-loader-plugin` module in a virtual environment:
```bash
$ pipenv shell
(python-...-JwpAHotb) ✔ python -mpip install -U data-loader-plugin
(python-...-JwpAHotb) ✔ python -mpip install -U data-loader-plugin
(python-...-JwpAHotb) ✔ exit
```
## Use `data-loader-plugin` as a module from another Python program
* Check the data file with the AWS command-line (CLI):
```bash
$ aws s3 ls --human s3://nyc-tlc/trip\ data/yellow_tripdata_2021-07.csv --no-sign-request
2021-10-29 20:44:34 249.3 MiB yellow_tripdata_2021-07.csv
```
* Module import statements:
```python
>>> import importlib
>>> from types import ModuleType
>>> from data_loader_plugin.base import DataLoaderBase
```
* Create an instance of the DataLoaderBase Python class:
```python
>>> plugin: ModuleType = importlib.import_module("data_loader_plugin.copyfile")
>>> data_loader: DataLoaderBase = plugin.DataLoader(
local_path='/tmp/yellow_tripdata_2021-07.csv',
external_url='s3://nyc-tlc/trip\ data/yellow_tripdata_2021-07.csv',
)
>>> data_load_success, message = data_loader.load()
```
# Development / Contribution
* Build the source distribution and Python artifacts (wheels):
```bash
$ rm -rf _skbuild/ build/ dist/ .tox/ __pycache__/ .pytest_cache/ MANIFEST *.egg-info/
$ pipenv run python setup.py sdist bdist_wheel
```
* Upload to Test PyPi (no Linux binary wheel can be uploaded on PyPi):
```bash
$ PYPIURL="https://test.pypi.org"
$ pipenv run twine upload -u __token__ --repository-url ${PYPIURL}/legacy/ dist/*
Uploading distributions to https://test.pypi.org/legacy/
Uploading data_loader_plugin-0.0.1-py3-none-any.whl
100%|███████████████████████████████████████| 23.1k/23.1k [00:02<00:00, 5.84kB/s]
Uploading data-loader-plugin-0.0.1.tar.gz
100%|███████████████████████████████████████| 23.0k/23.0k [00:01<00:00, 15.8kB/s]
View at:
https://test.pypi.org/project/data-loader-plugin/0.0.1/
```
* Upload/release the Python packages onto the
[PyPi repository](https://pypi.org):
+ Register the authentication token for access to PyPi:
```bash
$ PYPIURL="https://upload.pypi.org"
$ pipenv run keyring set ${PYPIURL}/ __token__
Password for '__token__' in '${PYPIURL}/':
```
+ Register the authentication token for access to PyPi:
```bash
$ pipenv run twine upload -u __token__ --repository-url ${PYPIURL}/legacy/ dist/*
Uploading distributions to https://upload.pypi.org/legacy/
Uploading data_loader_plugin-0.0.1-py3-none-any.whl
100%|███████████████████████████████████████| 23.1k/23.1k [00:02<00:00, 5.84kB/s]
Uploading data-loader-plugin-0.0.1.tar.gz
100%|███████████████████████████████████████| 23.0k/23.0k [00:01<00:00, 15.8kB/s]
View at:
https://pypi.org/project/data-loader-plugin/0.0.1/
```
* Note that the documentation is built automatically by ReadTheDocs (RTD)
+ The documentation is available from
https://data-loader-plugin.readthedocs.io/en/latest/
+ The RTD project is setup on https://readthedocs.org/projects/data-loader-plugin/
* Build the documentation manually (with [Sphinx](http://sphinx-doc.org)):
```bash
$ pipenv run python setup.py build_sphinx
running build_sphinx
Running Sphinx v4.3.0
[autosummary] generating autosummary for: README.md
myst v0.15.2: ..., words_per_minute=200)
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 1 source files that are out of date
updating environment: [new config] 1 added, 0 changed, 0 removed
reading sources... [100%] README
...
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] README
...
build succeeded.
The HTML pages are in build/sphinx/html.
```
* Re-generate the Python dependency files (`requirements.txt`)
for the CI/CD pipeline (currently Travis CI):
```bash
$ pipenv --rm; rm -f Pipfile.lock; pipenv install; pipenv install --dev
$ git add Pipfile.lock
$ pipenv lock -r > ci/requirements.txt
$ pipenv lock --dev -r > ci/requirements-dev.txt
$ git add ci/requirements.txt ci/requirements-dev.txt
$ git commit -m "[CI] Upgraded the Python dependencies for the Travis CI pipeline"
```
## Test the data loader plugin Python module
* Enter into the `pipenv` Shell:
```bash
$ pipenv shell
(python-...-iVzKEypY) ✔ python -V
Python 3.9.8
```
* Uninstall any previously installed `data-loader-plugin` module/library:
```bash
(python-...-iVzKEypY) ✔ python -mpip uninstall data-loader-plugin
```
* Launch a simple test with `pytest`
```bash
(python-iVzKEypY) ✔ python -mpytest tests
=================== test session starts ==================
platform darwin -- Python 3.9.8, pytest-6.2.5, py-1.11.0, pluggy-1.0.0
rootdir: ~/dev/infra/python-plugin-data-loader
plugins: cov-3.0.0
collected 3 items
tests/test_copyfile.py . [ 33%]
tests/test_s3.py .. [100%]
====================== 3 passed in 1.22s ==================
```
* Exit the `pipenv` Shell:
```bash
(python-...-iVzKEypY) ✔ exit
```
نیازمندی
| مقدار | نام |
|---|---|
| - | boto3 |
زبان مورد نیاز
| مقدار | نام |
|---|---|
| >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.* | Python |
نحوه نصب
نصب پکیج whl data-loader-plugin-0.0.1.post1:
pip install data-loader-plugin-0.0.1.post1.whl
نصب پکیج tar.gz data-loader-plugin-0.0.1.post1:
pip install data-loader-plugin-0.0.1.post1.tar.gz