| Name | fake-py-pathy-storage JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | None |
| Summary | Pathy storage for fake.py |
| upload_time | 2024-09-11 19:52:23 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | None |
| license | MIT |
| keywords |
fake data
test data
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
=====================
fake-py-pathy-storage
=====================
.. External references
.. _fake.py: https://fakepy.readthedocs.io/
.. _Pathy: https://github.com/justindujardin/pathy
.. _faker-file: https://faker-file.readthedocs.io/
.. _Django: https://www.djangoproject.com/
.. Internal references
.. _fake-py-pathy-storage: https://github.com/barseghyanartur/fake-py-pathy-storage/
.. _Read the Docs: http://fake-py-pathy-storage.readthedocs.io/
.. _Contributor guidelines: https://fake-py-pathy-storage.readthedocs.io/en/latest/contributor_guidelines.html
`Pathy`_ storage for `fake.py`_.
.. image:: https://img.shields.io/pypi/v/fake-py-pathy-storage.svg
:target: https://pypi.python.org/pypi/fake-py-pathy-storage
:alt: PyPI Version
.. image:: https://img.shields.io/pypi/pyversions/fake-py-pathy-storage.svg
:target: https://pypi.python.org/pypi/fake-py-pathy-storage/
:alt: Supported Python versions
.. image:: https://github.com/barseghyanartur/fake-py-pathy-storage/actions/workflows/test.yml/badge.svg?branch=main
:target: https://github.com/barseghyanartur/fake-py-pathy-storage/actions
:alt: Build Status
.. image:: https://readthedocs.org/projects/fake-py-pathy-storage/badge/?version=latest
:target: http://fake-py-pathy-storage.readthedocs.io
:alt: Documentation Status
.. image:: https://img.shields.io/badge/license-MIT-blue.svg
:target: https://github.com/barseghyanartur/fake-py-pathy-storage/#License
:alt: MIT
.. image:: https://coveralls.io/repos/github/barseghyanartur/fake-py-pathy-storage/badge.svg?branch=main&service=github
:target: https://coveralls.io/github/barseghyanartur/fake-py-pathy-storage?branch=main
:alt: Coverage
`fake-py-pathy-storage`_ is a `Pathy`_ storage integration for `fake.py`_ - a
standalone, portable library designed for generating various
random data types for testing.
Features
========
- Cloud storages integration includes support for AWS S3, Google Cloud Storage
and Azure Cloud Storage.
Prerequisites
=============
Python 3.9+
Installation
============
.. code-block:: sh
pip install fake-py-pathy-storage
Documentation
=============
- Documentation is available on `Read the Docs`_.
- For guidelines on contributing check the `Contributor guidelines`_.
Usage
=====
Local cloud-alike file system storage
-------------------------------------
.. code-block:: python
:name: test_pathy_file_system_storage
from fake import FAKER
from fakepy.pathy_storage.cloud import PathyFileSystemStorage
STORAGE = PathyFileSystemStorage(
bucket_name="bucket_name",
root_path="tmp", # Optional
rel_path="sub-tmp", # Optional
)
pdf_file = FAKER.pdf_file(storage=STORAGE)
STORAGE.exists(pdf_file)
AWS S3
------
.. code-block:: python
from fake import FAKER
from fakepy.pathy_storage.aws_s3 import AWSS3Storage
STORAGE = AWSS3Storage(
bucket_name="bucket_name",
root_path="tmp", # Optional
rel_path="sub-tmp", # Optional
# Credentials are optional too. If your AWS credentials are properly
# set in the ~/.aws/credentials, you don't need to send them
# explicitly.
credentials={
"key_id": "YOUR KEY ID",
"key_secret": "YOUR KEY SECRET"
},
)
pdf_file = FAKER.pdf_file(storage=STORAGE)
STORAGE.exists(pdf_file)
Google Cloud Storage
--------------------
.. code-block:: python
from fake import FAKER
from fakepy.pathy_storage.google_cloud_storage import GoogleCloudStorage
STORAGE = GoogleCloudStorage(
bucket_name="bucket_name",
root_path="tmp", # Optional
rel_path="sub-tmp", # Optional
)
pdf_file = FAKER.pdf_file(storage=STORAGE)
STORAGE.exists(pdf_file)
Azure Cloud Storage
-------------------
.. code-block:: python
from fake import FAKER
from fakepy.pathy_storage.azure_cloud_storage import AzureCloudStorage
STORAGE = AzureCloudStorage(
bucket_name="bucket_name",
root_path="tmp", # Optional
rel_path="sub-tmp", # Optional
)
pdf_file = FAKER.pdf_file(storage=STORAGE)
STORAGE.exists(pdf_file)
Tests
=====
.. code-block:: sh
pytest
Writing documentation
=====================
Keep the following hierarchy.
.. code-block:: text
=====
title
=====
header
======
sub-header
----------
sub-sub-header
~~~~~~~~~~~~~~
sub-sub-sub-header
^^^^^^^^^^^^^^^^^^
sub-sub-sub-sub-header
++++++++++++++++++++++
sub-sub-sub-sub-sub-header
**************************
License
=======
MIT
Support
=======
For security issues contact me at the e-mail given in the `Author`_ section.
For overall issues, go to `GitHub <https://github.com/barseghyanartur/fake-py-pathy-storage/issues>`_.
Author
======
Artur Barseghyan <artur.barseghyan@gmail.com>
Raw data
{
"_id": null,
"home_page": null,
"name": "fake-py-pathy-storage",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": "Artur Barseghyan <artur.barseghyan@gmail.com>",
"keywords": "fake data, test data",
"author": null,
"author_email": "Artur Barseghyan <artur.barseghyan@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/4f/de/b7b62c10978ca505510aaec675e667ec1f4efc8b8dc6609ca827cc7d6430/fake_py_pathy_storage-0.1.1.tar.gz",
"platform": null,
"description": "=====================\nfake-py-pathy-storage\n=====================\n.. External references\n\n.. _fake.py: https://fakepy.readthedocs.io/\n.. _Pathy: https://github.com/justindujardin/pathy\n.. _faker-file: https://faker-file.readthedocs.io/\n.. _Django: https://www.djangoproject.com/\n\n.. Internal references\n\n.. _fake-py-pathy-storage: https://github.com/barseghyanartur/fake-py-pathy-storage/\n.. _Read the Docs: http://fake-py-pathy-storage.readthedocs.io/\n.. _Contributor guidelines: https://fake-py-pathy-storage.readthedocs.io/en/latest/contributor_guidelines.html\n\n`Pathy`_ storage for `fake.py`_.\n\n.. image:: https://img.shields.io/pypi/v/fake-py-pathy-storage.svg\n :target: https://pypi.python.org/pypi/fake-py-pathy-storage\n :alt: PyPI Version\n\n.. image:: https://img.shields.io/pypi/pyversions/fake-py-pathy-storage.svg\n :target: https://pypi.python.org/pypi/fake-py-pathy-storage/\n :alt: Supported Python versions\n\n.. image:: https://github.com/barseghyanartur/fake-py-pathy-storage/actions/workflows/test.yml/badge.svg?branch=main\n :target: https://github.com/barseghyanartur/fake-py-pathy-storage/actions\n :alt: Build Status\n\n.. image:: https://readthedocs.org/projects/fake-py-pathy-storage/badge/?version=latest\n :target: http://fake-py-pathy-storage.readthedocs.io\n :alt: Documentation Status\n\n.. image:: https://img.shields.io/badge/license-MIT-blue.svg\n :target: https://github.com/barseghyanartur/fake-py-pathy-storage/#License\n :alt: MIT\n\n.. image:: https://coveralls.io/repos/github/barseghyanartur/fake-py-pathy-storage/badge.svg?branch=main&service=github\n :target: https://coveralls.io/github/barseghyanartur/fake-py-pathy-storage?branch=main\n :alt: Coverage\n\n`fake-py-pathy-storage`_ is a `Pathy`_ storage integration for `fake.py`_ - a\nstandalone, portable library designed for generating various\nrandom data types for testing.\n\nFeatures\n========\n- Cloud storages integration includes support for AWS S3, Google Cloud Storage\n and Azure Cloud Storage.\n\nPrerequisites\n=============\nPython 3.9+\n\nInstallation\n============\n\n.. code-block:: sh\n\n pip install fake-py-pathy-storage\n\nDocumentation\n=============\n- Documentation is available on `Read the Docs`_.\n- For guidelines on contributing check the `Contributor guidelines`_.\n\nUsage\n=====\nLocal cloud-alike file system storage\n-------------------------------------\n.. code-block:: python\n :name: test_pathy_file_system_storage\n\n from fake import FAKER\n from fakepy.pathy_storage.cloud import PathyFileSystemStorage\n\n STORAGE = PathyFileSystemStorage(\n bucket_name=\"bucket_name\",\n root_path=\"tmp\", # Optional\n rel_path=\"sub-tmp\", # Optional\n )\n\n pdf_file = FAKER.pdf_file(storage=STORAGE)\n\n STORAGE.exists(pdf_file)\n\nAWS S3\n------\n\n.. code-block:: python\n\n from fake import FAKER\n from fakepy.pathy_storage.aws_s3 import AWSS3Storage\n\n STORAGE = AWSS3Storage(\n bucket_name=\"bucket_name\",\n root_path=\"tmp\", # Optional\n rel_path=\"sub-tmp\", # Optional\n # Credentials are optional too. If your AWS credentials are properly\n # set in the ~/.aws/credentials, you don't need to send them\n # explicitly.\n credentials={\n \"key_id\": \"YOUR KEY ID\",\n \"key_secret\": \"YOUR KEY SECRET\"\n },\n )\n\n pdf_file = FAKER.pdf_file(storage=STORAGE)\n\n STORAGE.exists(pdf_file)\n\nGoogle Cloud Storage\n--------------------\n.. code-block:: python\n\n from fake import FAKER\n from fakepy.pathy_storage.google_cloud_storage import GoogleCloudStorage\n\n STORAGE = GoogleCloudStorage(\n bucket_name=\"bucket_name\",\n root_path=\"tmp\", # Optional\n rel_path=\"sub-tmp\", # Optional\n )\n\n pdf_file = FAKER.pdf_file(storage=STORAGE)\n\n STORAGE.exists(pdf_file)\n\nAzure Cloud Storage\n-------------------\n.. code-block:: python\n\n from fake import FAKER\n from fakepy.pathy_storage.azure_cloud_storage import AzureCloudStorage\n\n STORAGE = AzureCloudStorage(\n bucket_name=\"bucket_name\",\n root_path=\"tmp\", # Optional\n rel_path=\"sub-tmp\", # Optional\n )\n\n pdf_file = FAKER.pdf_file(storage=STORAGE)\n\n STORAGE.exists(pdf_file)\n\nTests\n=====\n\n.. code-block:: sh\n\n pytest\n\nWriting documentation\n=====================\n\nKeep the following hierarchy.\n\n.. code-block:: text\n\n =====\n title\n =====\n\n header\n ======\n\n sub-header\n ----------\n\n sub-sub-header\n ~~~~~~~~~~~~~~\n\n sub-sub-sub-header\n ^^^^^^^^^^^^^^^^^^\n\n sub-sub-sub-sub-header\n ++++++++++++++++++++++\n\n sub-sub-sub-sub-sub-header\n **************************\n\nLicense\n=======\n\nMIT\n\nSupport\n=======\nFor security issues contact me at the e-mail given in the `Author`_ section.\n\nFor overall issues, go to `GitHub <https://github.com/barseghyanartur/fake-py-pathy-storage/issues>`_.\n\nAuthor\n======\n\nArtur Barseghyan <artur.barseghyan@gmail.com>\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Pathy storage for fake.py",
"version": "0.1.1",
"project_urls": {
"Changelog": "https://fake-py-pathy-storage.readthedocs.io/en/latest/changelog.html",
"Documentation": "https://fake-py-pathy-storage.readthedocs.io/",
"Homepage": "https://github.com/barseghyanartur/fake-py-pathy-storage/",
"Issues": "https://github.com/barseghyanartur/fake-py-pathy-storage/issues",
"Repository": "https://github.com/barseghyanartur/fake-py-pathy-storage/"
},
"split_keywords": [
"fake data",
" test data"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9374ff7e780c134a4f66f62f241de6e94062a4d11e7c0b7083a521fa5d8b12cd",
"md5": "53975db6c2bee09b765cf8fbce52a99d",
"sha256": "349beb4882078b472f5aa76d69e061c1360d71fb43f0b7c4a7490d195e1e983f"
},
"downloads": -1,
"filename": "fake_py_pathy_storage-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "53975db6c2bee09b765cf8fbce52a99d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 11836,
"upload_time": "2024-09-11T19:52:21",
"upload_time_iso_8601": "2024-09-11T19:52:21.844618Z",
"url": "https://files.pythonhosted.org/packages/93/74/ff7e780c134a4f66f62f241de6e94062a4d11e7c0b7083a521fa5d8b12cd/fake_py_pathy_storage-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4fdeb7b62c10978ca505510aaec675e667ec1f4efc8b8dc6609ca827cc7d6430",
"md5": "3d21ce748ac21c36d7004c685a781230",
"sha256": "8ff1b16f4fa3a587f78a442dc899f2d2a20bb9da219b2c2c302000ed6e2cfb8d"
},
"downloads": -1,
"filename": "fake_py_pathy_storage-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "3d21ce748ac21c36d7004c685a781230",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 26412,
"upload_time": "2024-09-11T19:52:23",
"upload_time_iso_8601": "2024-09-11T19:52:23.687072Z",
"url": "https://files.pythonhosted.org/packages/4f/de/b7b62c10978ca505510aaec675e667ec1f4efc8b8dc6609ca827cc7d6430/fake_py_pathy_storage-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-11 19:52:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "barseghyanartur",
"github_project": "fake-py-pathy-storage",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "fake-py-pathy-storage"
}
