======================
fake-py-django-storage
======================
.. External references
.. _fake.py: https://fakepy.readthedocs.io
.. _faker-file: https://faker-file.readthedocs.io
.. _Django: https://www.djangoproject.com
.. _django-storages: https://django-storages.readthedocs.io
.. Internal references
.. _fake-py-django-storage: https://github.com/barseghyanartur/fake-py-django-storage
.. _Read the Docs: http://fake-py-django-storage.readthedocs.io
.. _Contributor guidelines: https://fake-py-django-storage.readthedocs.io/en/latest/contributor_guidelines.html
`Django`_ storage for `fake.py`_.
.. image:: https://img.shields.io/pypi/v/fake-py-django-storage.svg
:target: https://pypi.python.org/pypi/fake-py-django-storage
:alt: PyPI Version
.. image:: https://img.shields.io/pypi/pyversions/fake-py-django-storage.svg
:target: https://pypi.python.org/pypi/fake-py-django-storage/
:alt: Supported Python versions
.. image:: https://github.com/barseghyanartur/fake-py-django-storage/actions/workflows/test.yml/badge.svg?branch=main
:target: https://github.com/barseghyanartur/fake-py-django-storage/actions
:alt: Build Status
.. image:: https://readthedocs.org/projects/fake-py-django-storage/badge/?version=latest
:target: http://fake-py-django-storage.readthedocs.io
:alt: Documentation Status
.. image:: https://img.shields.io/badge/license-MIT-blue.svg
:target: https://github.com/barseghyanartur/fake-py-django-storage/#License
:alt: MIT
.. image:: https://coveralls.io/repos/github/barseghyanartur/fake-py-django-storage/badge.svg?branch=main&service=github
:target: https://coveralls.io/github/barseghyanartur/fake-py-django-storage?branch=main
:alt: Coverage
`fake-py-django-storage`_ is a `Django`_ storage integration for `fake.py`_ - a
standalone, portable library designed for generating various
random data types for testing.
Features
========
- Almost seamless integration with `Django`_ (and `django-storages`_).
Prerequisites
=============
Python 3.9+
Installation
============
.. code-block:: sh
pip install fake-py-django-storage
Documentation
=============
- Documentation is available on `Read the Docs`_.
- For guidelines on contributing check the `Contributor guidelines`_.
Usage
=====
`FileSystemStorage` of `Django`
-------------------------------
.. code-block:: python
from fake import FAKER
from fakepy.django_storage.filesystem import DjangoFileSystemStorage
STORAGE = DjangoFileSystemStorage(
root_path="tmp", # Optional
rel_path="sub-tmp", # Optional
)
pdf_file = FAKER.pdf_file(storage=STORAGE)
STORAGE.exists(pdf_file)
AWS S3 (using `django-storages`)
--------------------------------
.. code-block:: python
from fake import FAKER
from fakepy.django_storage.aws_s3 import DjangoAWSS3Storage
STORAGE = DjangoAWSS3Storage(
root_path="tmp", # Optional
rel_path="sub-tmp", # Optional
)
pdf_file = FAKER.pdf_file(storage=STORAGE)
STORAGE.exists(pdf_file)
Google Cloud Storage (using `django-storages`)
----------------------------------------------
.. code-block:: python
from fake import FAKER
from fakepy.django_storage.google_cloud_storage import (
DjangoGoogleCloudStorage,
)
STORAGE = DjangoGoogleCloudStorage(
root_path="tmp", # Optional
rel_path="sub-tmp", # Optional
)
pdf_file = FAKER.pdf_file(storage=STORAGE)
STORAGE.exists(pdf_file)
Azure Cloud Storage (using `django-storages`)
---------------------------------------------
.. code-block:: python
from fake import FAKER
from fakepy.django_storage.azure_cloud_storage import (
DjangoAzureCloudStorage,
)
STORAGE = DjangoAzureCloudStorage(
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-django-storage/issues>`_.
Author
======
Artur Barseghyan <artur.barseghyan@gmail.com>
Raw data
{
"_id": null,
"home_page": null,
"name": "fake-py-django-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/c6/23/2ccf0be8106457a4044a7b5ba6af9886dd86803fa374ba226d1471614cab/fake_py_django_storage-0.1.1.tar.gz",
"platform": null,
"description": "======================\nfake-py-django-storage\n======================\n.. External references\n\n.. _fake.py: https://fakepy.readthedocs.io\n.. _faker-file: https://faker-file.readthedocs.io\n.. _Django: https://www.djangoproject.com\n.. _django-storages: https://django-storages.readthedocs.io\n\n.. Internal references\n\n.. _fake-py-django-storage: https://github.com/barseghyanartur/fake-py-django-storage\n.. _Read the Docs: http://fake-py-django-storage.readthedocs.io\n.. _Contributor guidelines: https://fake-py-django-storage.readthedocs.io/en/latest/contributor_guidelines.html\n\n`Django`_ storage for `fake.py`_.\n\n.. image:: https://img.shields.io/pypi/v/fake-py-django-storage.svg\n :target: https://pypi.python.org/pypi/fake-py-django-storage\n :alt: PyPI Version\n\n.. image:: https://img.shields.io/pypi/pyversions/fake-py-django-storage.svg\n :target: https://pypi.python.org/pypi/fake-py-django-storage/\n :alt: Supported Python versions\n\n.. image:: https://github.com/barseghyanartur/fake-py-django-storage/actions/workflows/test.yml/badge.svg?branch=main\n :target: https://github.com/barseghyanartur/fake-py-django-storage/actions\n :alt: Build Status\n\n.. image:: https://readthedocs.org/projects/fake-py-django-storage/badge/?version=latest\n :target: http://fake-py-django-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-django-storage/#License\n :alt: MIT\n\n.. image:: https://coveralls.io/repos/github/barseghyanartur/fake-py-django-storage/badge.svg?branch=main&service=github\n :target: https://coveralls.io/github/barseghyanartur/fake-py-django-storage?branch=main\n :alt: Coverage\n\n`fake-py-django-storage`_ is a `Django`_ storage integration for `fake.py`_ - a\nstandalone, portable library designed for generating various\nrandom data types for testing.\n\nFeatures\n========\n- Almost seamless integration with `Django`_ (and `django-storages`_).\n\nPrerequisites\n=============\nPython 3.9+\n\nInstallation\n============\n\n.. code-block:: sh\n\n pip install fake-py-django-storage\n\nDocumentation\n=============\n- Documentation is available on `Read the Docs`_.\n- For guidelines on contributing check the `Contributor guidelines`_.\n\nUsage\n=====\n`FileSystemStorage` of `Django`\n-------------------------------\n.. code-block:: python\n\n from fake import FAKER\n from fakepy.django_storage.filesystem import DjangoFileSystemStorage\n\n STORAGE = DjangoFileSystemStorage(\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 (using `django-storages`)\n--------------------------------\n.. code-block:: python\n\n from fake import FAKER\n from fakepy.django_storage.aws_s3 import DjangoAWSS3Storage\n\n STORAGE = DjangoAWSS3Storage(\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\nGoogle Cloud Storage (using `django-storages`)\n----------------------------------------------\n.. code-block:: python\n\n from fake import FAKER\n from fakepy.django_storage.google_cloud_storage import (\n DjangoGoogleCloudStorage,\n )\n\n STORAGE = DjangoGoogleCloudStorage(\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 (using `django-storages`)\n---------------------------------------------\n.. code-block:: python\n\n from fake import FAKER\n from fakepy.django_storage.azure_cloud_storage import (\n DjangoAzureCloudStorage,\n )\n\n STORAGE = DjangoAzureCloudStorage(\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-django-storage/issues>`_.\n\nAuthor\n======\n\nArtur Barseghyan <artur.barseghyan@gmail.com>\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Django storage for fake.py",
"version": "0.1.1",
"project_urls": {
"Changelog": "https://fake-py-django-storage.readthedocs.io/en/latest/changelog.html",
"Documentation": "https://fake-py-django-storage.readthedocs.io/",
"Homepage": "https://github.com/barseghyanartur/fake-py-django-storage/",
"Issues": "https://github.com/barseghyanartur/fake-py-django-storage/issues",
"Repository": "https://github.com/barseghyanartur/fake-py-django-storage/"
},
"split_keywords": [
"fake data",
" test data"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9f837e4d0e2a829f1718433e0afa13a8bd6f51b464a0562365612d6ea7e8bb6f",
"md5": "8afad2d63f4cacbcf93970b347908234",
"sha256": "855f9911f7a2b8da81d0a32680c61b830f8ce3f7df7fe048779af82e9bded587"
},
"downloads": -1,
"filename": "fake_py_django_storage-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8afad2d63f4cacbcf93970b347908234",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 13465,
"upload_time": "2024-09-11T19:17:23",
"upload_time_iso_8601": "2024-09-11T19:17:23.836942Z",
"url": "https://files.pythonhosted.org/packages/9f/83/7e4d0e2a829f1718433e0afa13a8bd6f51b464a0562365612d6ea7e8bb6f/fake_py_django_storage-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c6232ccf0be8106457a4044a7b5ba6af9886dd86803fa374ba226d1471614cab",
"md5": "b98756ed422145e24ae5693100bdff2d",
"sha256": "a25ed8ee0d54097a63bcc9485826f295701a006e15b06dd949ed9493018743ec"
},
"downloads": -1,
"filename": "fake_py_django_storage-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "b98756ed422145e24ae5693100bdff2d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 32587,
"upload_time": "2024-09-11T19:17:25",
"upload_time_iso_8601": "2024-09-11T19:17:25.756521Z",
"url": "https://files.pythonhosted.org/packages/c6/23/2ccf0be8106457a4044a7b5ba6af9886dd86803fa374ba226d1471614cab/fake_py_django_storage-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-11 19:17:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "barseghyanartur",
"github_project": "fake-py-django-storage",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "fake-py-django-storage"
}
JSON
