=============
faker-file-qt
=============
PyQT UI for `faker-file`_.
.. image:: https://img.shields.io/pypi/v/faker-file-qt.svg
:target: https://pypi.python.org/pypi/faker-file-qt
:alt: PyPI Version
.. image:: https://img.shields.io/pypi/pyversions/faker-file-qt.svg
:target: https://pypi.python.org/pypi/faker-file-qt/
:alt: Supported Python versions
.. image:: https://github.com/barseghyanartur/faker-file-qt/workflows/test/badge.svg?branch=main
:target: https://github.com/barseghyanartur/faker-file-qt/actions
:alt: Build Status
.. image:: https://readthedocs.org/projects/faker-file-qt/badge/?version=latest
:target: http://faker-file-qt.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. image:: https://img.shields.io/badge/license-MIT-blue.svg
:target: https://github.com/barseghyanartur/faker-file-qt/#License
:alt: MIT
.. image:: https://coveralls.io/repos/github/barseghyanartur/faker-file-qt/badge.svg?branch=main&service=github
:target: https://coveralls.io/github/barseghyanartur/faker-file-qt?branch=main
:alt: Coverage
.. Internal references
.. _Read the Docs: http://faker-file-qt.readthedocs.io/
.. Related projects
.. _faker-file: https://github.com/barseghyanartur/faker-file/
.. _faker-file-api: https://github.com/barseghyanartur/faker-file-api
.. _faker-file-ui: https://github.com/barseghyanartur/faker-file-ui
.. _faker-file-wasm: https://github.com/barseghyanartur/faker-file-wasm
.. Demos
.. _REST API demo: https://faker-file-api.onrender.com/docs/
.. _UI frontend demo: https://faker-file-ui.vercel.app/
.. _WASM frontend demo: https://faker-file-wasm.vercel.app/
.. External references
.. _Apache Tika: https://tika.apache.org/
.. _Django: https://www.djangoproject.com/
.. _Faker: https://faker.readthedocs.io/
.. _Jinja2: https://jinja.palletsprojects.com/
.. _Pillow: https://pypi.org/project/Pillow/
.. _PyTorch: https://pytorch.org/
.. _WeasyPrint: https://pypi.org/project/weasyprint/
.. _azure-storage-blob: https://pypi.org/project/azure-storage-blob/
.. _boto3: https://pypi.org/project/boto3/
.. _edge-tts: https://pypi.org/project/edge-tts/
.. _factory_boy: https://factoryboy.readthedocs.io/
.. _gTTS: https://gtts.readthedocs.io/
.. _google-cloud-storage: https://pypi.org/project/google-cloud-storage/
.. _imgkit: https://pypi.org/project/imgkit/
.. _nlpaug: https://nlpaug.readthedocs.io/
.. _numpy: https://numpy.org/
.. _odfpy: https://pypi.org/project/odfpy/
.. _openpyxl: https://openpyxl.readthedocs.io/
.. _pandas: https://pandas.pydata.org/
.. _pdf2image: https://pypi.org/project/pdf2image/
.. _paramiko: http://paramiko.org/
.. _pathy: https://pypi.org/project/pathy/
.. _pdfkit: https://pypi.org/project/pdfkit/
.. _poppler: https://poppler.freedesktop.org/
.. _python-docx: https://python-docx.readthedocs.io/
.. _python-pptx: https://python-pptx.readthedocs.io/
.. _PyQT5: https://pypi.org/project/PyQt5/
.. _QDarkStyle: https://pypi.org/project/QDarkStyle/
.. _reportlab: https://pypi.org/project/reportlab/
.. _tablib: https://tablib.readthedocs.io/
.. _tika: https://pypi.org/project/tika/
.. _transformers: https://pypi.org/project/transformers/
.. _wkhtmltopdf: https://wkhtmltopdf.org/
.. _xml2epub: https://pypi.org/project/xml2epub/
Prerequisites
=============
- `faker-file`_ (``faker-file[common]``)
- `QDarkStyle`_
- `PyQT5`_
Documentation
=============
- Documentation is available on `Read the Docs`_.
Installation
============
Latest stable version from PyPI
-------------------------------
.. code-block:: sh
pipx install faker-file-qt
Or development version from GitHub
----------------------------------
.. code-block:: sh
pipx install https://github.com/barseghyanartur/faker-file-qt/archive/main.tar.gz
Install locally in development mode
-----------------------------------
.. code-block:: sh
pip install -e .[dev]
Running
=======
.. code-block:: sh
faker-file-qt
Testing
=======
Simply type:
.. code-block:: sh
pytest -vrx
Or use tox:
.. code-block:: sh
tox
Related projects
================
Check the demo(s):
- `REST API demo`_ (based on `faker-file-api`_ REST API)
- `UI frontend demo`_ (based on `faker-file-ui`_ UI frontend)
- `WASM frontend demo`_ (based on `faker-file-wasm`_ WASM frontend)
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/faker-file-qt/issues>`_.
Author
======
Artur Barseghyan <artur.barseghyan@gmail.com>
Raw data
{
"_id": null,
"home_page": "https://github.com/barseghyanartur/faker-file-qt/",
"name": "faker-file-qt",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "faker-file faker-file-qt",
"author": "Artur Barseghyan",
"author_email": "artur.barseghyan@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/4b/f2/e18c2a5d5a21bbacebb25a8fd70939b1c2176822ecc4f35ede458219e129/faker-file-qt-0.1.4.tar.gz",
"platform": null,
"description": "=============\nfaker-file-qt\n=============\nPyQT UI for `faker-file`_.\n\n.. image:: https://img.shields.io/pypi/v/faker-file-qt.svg\n :target: https://pypi.python.org/pypi/faker-file-qt\n :alt: PyPI Version\n\n.. image:: https://img.shields.io/pypi/pyversions/faker-file-qt.svg\n :target: https://pypi.python.org/pypi/faker-file-qt/\n :alt: Supported Python versions\n\n.. image:: https://github.com/barseghyanartur/faker-file-qt/workflows/test/badge.svg?branch=main\n :target: https://github.com/barseghyanartur/faker-file-qt/actions\n :alt: Build Status\n\n.. image:: https://readthedocs.org/projects/faker-file-qt/badge/?version=latest\n :target: http://faker-file-qt.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\n.. image:: https://img.shields.io/badge/license-MIT-blue.svg\n :target: https://github.com/barseghyanartur/faker-file-qt/#License\n :alt: MIT\n\n.. image:: https://coveralls.io/repos/github/barseghyanartur/faker-file-qt/badge.svg?branch=main&service=github\n :target: https://coveralls.io/github/barseghyanartur/faker-file-qt?branch=main\n :alt: Coverage\n\n.. Internal references\n\n.. _Read the Docs: http://faker-file-qt.readthedocs.io/\n\n.. Related projects\n\n.. _faker-file: https://github.com/barseghyanartur/faker-file/\n.. _faker-file-api: https://github.com/barseghyanartur/faker-file-api\n.. _faker-file-ui: https://github.com/barseghyanartur/faker-file-ui\n.. _faker-file-wasm: https://github.com/barseghyanartur/faker-file-wasm\n\n.. Demos\n\n.. _REST API demo: https://faker-file-api.onrender.com/docs/\n.. _UI frontend demo: https://faker-file-ui.vercel.app/\n.. _WASM frontend demo: https://faker-file-wasm.vercel.app/\n\n.. External references\n\n.. _Apache Tika: https://tika.apache.org/\n.. _Django: https://www.djangoproject.com/\n.. _Faker: https://faker.readthedocs.io/\n.. _Jinja2: https://jinja.palletsprojects.com/\n.. _Pillow: https://pypi.org/project/Pillow/\n.. _PyTorch: https://pytorch.org/\n.. _WeasyPrint: https://pypi.org/project/weasyprint/\n.. _azure-storage-blob: https://pypi.org/project/azure-storage-blob/\n.. _boto3: https://pypi.org/project/boto3/\n.. _edge-tts: https://pypi.org/project/edge-tts/\n.. _factory_boy: https://factoryboy.readthedocs.io/\n.. _gTTS: https://gtts.readthedocs.io/\n.. _google-cloud-storage: https://pypi.org/project/google-cloud-storage/\n.. _imgkit: https://pypi.org/project/imgkit/\n.. _nlpaug: https://nlpaug.readthedocs.io/\n.. _numpy: https://numpy.org/\n.. _odfpy: https://pypi.org/project/odfpy/\n.. _openpyxl: https://openpyxl.readthedocs.io/\n.. _pandas: https://pandas.pydata.org/\n.. _pdf2image: https://pypi.org/project/pdf2image/\n.. _paramiko: http://paramiko.org/\n.. _pathy: https://pypi.org/project/pathy/\n.. _pdfkit: https://pypi.org/project/pdfkit/\n.. _poppler: https://poppler.freedesktop.org/\n.. _python-docx: https://python-docx.readthedocs.io/\n.. _python-pptx: https://python-pptx.readthedocs.io/\n.. _PyQT5: https://pypi.org/project/PyQt5/\n.. _QDarkStyle: https://pypi.org/project/QDarkStyle/\n.. _reportlab: https://pypi.org/project/reportlab/\n.. _tablib: https://tablib.readthedocs.io/\n.. _tika: https://pypi.org/project/tika/\n.. _transformers: https://pypi.org/project/transformers/\n.. _wkhtmltopdf: https://wkhtmltopdf.org/\n.. _xml2epub: https://pypi.org/project/xml2epub/\n\nPrerequisites\n=============\n- `faker-file`_ (``faker-file[common]``)\n- `QDarkStyle`_\n- `PyQT5`_\n\nDocumentation\n=============\n- Documentation is available on `Read the Docs`_.\n\nInstallation\n============\nLatest stable version from PyPI\n-------------------------------\n.. code-block:: sh\n\n pipx install faker-file-qt\n\nOr development version from GitHub\n----------------------------------\n\n.. code-block:: sh\n\n pipx install https://github.com/barseghyanartur/faker-file-qt/archive/main.tar.gz\n\nInstall locally in development mode\n-----------------------------------\n.. code-block:: sh\n\n pip install -e .[dev]\n\nRunning\n=======\n.. code-block:: sh\n\n faker-file-qt\n\nTesting\n=======\nSimply type:\n\n.. code-block:: sh\n\n pytest -vrx\n\nOr use tox:\n\n.. code-block:: sh\n\n tox\n\nRelated projects\n================\nCheck the demo(s):\n\n- `REST API demo`_ (based on `faker-file-api`_ REST API)\n- `UI frontend demo`_ (based on `faker-file-ui`_ UI frontend)\n- `WASM frontend demo`_ (based on `faker-file-wasm`_ WASM frontend)\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=======\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/faker-file-qt/issues>`_.\n\nAuthor\n======\nArtur Barseghyan <artur.barseghyan@gmail.com>\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "PyQT UI for faker-file.",
"version": "0.1.4",
"project_urls": {
"Bug Tracker": "https://github.com/barseghyanartur/faker-file-qt/issues",
"Changelog": "https://faker-file-qt.readthedocs.io/en/latest/changelog.html",
"Documentation": "https://faker-file-qt.readthedocs.io/",
"Homepage": "https://github.com/barseghyanartur/faker-file-qt/",
"Source Code": "https://github.com/barseghyanartur/faker-file-qt/"
},
"split_keywords": [
"faker-file",
"faker-file-qt"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b0586e32042abb40f7a070654298e62af1a6005f88d1d215fec9cbcb2918b925",
"md5": "d794ca38658262b3a0ad1d8b715199f0",
"sha256": "eac5347c2eab1f93e3492333666a8acdb890fa4452cd0acec4a702c744514349"
},
"downloads": -1,
"filename": "faker_file_qt-0.1.4-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "d794ca38658262b3a0ad1d8b715199f0",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.8",
"size": 8744,
"upload_time": "2023-09-23T20:49:43",
"upload_time_iso_8601": "2023-09-23T20:49:43.360902Z",
"url": "https://files.pythonhosted.org/packages/b0/58/6e32042abb40f7a070654298e62af1a6005f88d1d215fec9cbcb2918b925/faker_file_qt-0.1.4-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4bf2e18c2a5d5a21bbacebb25a8fd70939b1c2176822ecc4f35ede458219e129",
"md5": "3c066f14be9748e531606be90ca309d0",
"sha256": "d95b40837a13e792698fe9369b15e66af28292c5e3e3a5b54361335714abf7a2"
},
"downloads": -1,
"filename": "faker-file-qt-0.1.4.tar.gz",
"has_sig": false,
"md5_digest": "3c066f14be9748e531606be90ca309d0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 10632,
"upload_time": "2023-09-23T20:49:45",
"upload_time_iso_8601": "2023-09-23T20:49:45.187485Z",
"url": "https://files.pythonhosted.org/packages/4b/f2/e18c2a5d5a21bbacebb25a8fd70939b1c2176822ecc4f35ede458219e129/faker-file-qt-0.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-23 20:49:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "barseghyanartur",
"github_project": "faker-file-qt",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "faker-file-qt"
}
JSON
