Metadata-Version: 2.1
Name: python-object-getter
Version: 0.0.2
Summary: Import something from a module, while mocking anything in its namespace.
Home-page: https://github.com/boromir674/python-object-getter
Download-URL: https://github.com/boromir674/python-object-getter/archive/v0.0.2.tar.gz
Author: Konstantinos Lampridis
Author-email: k.lampridis@hotmail.com
License: AGPLv3
Project-URL: Bug Tracker, https://github.com/python-object-getter/issues
Project-URL: CI: Github Actions, https://github.com/boromir674/python-object-getter/actions
Project-URL: Documentation, https://python-object-getter.readthedocs.io/
Project-URL: Source Code, https://github.com/boromir674/python-object-getter
Keywords: python package
Platform: Linux
Platform: Darwin
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Natural Language :: English
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: System :: Software Distribution
Classifier: Typing :: Typed
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
License-File: LICENSE.txt
Provides-Extra: docs
Requires-Dist: furo (>=2021.08.31) ; extra == 'docs'
Requires-Dist: sphinx (~=4.0) ; extra == 'docs'
Requires-Dist: sphinx-argparse-cli (>=1.5) ; extra == 'docs'
Requires-Dist: sphinx-autodoc-typehints (>=1.10) ; extra == 'docs'
Provides-Extra: test
Requires-Dist: pytest (>=6.2.4) ; extra == 'test'
Requires-Dist: pytest-cov (>=2.12) ; extra == 'test'
Requires-Dist: pytest-xdist (>=1.34) ; extra == 'test'
Provides-Extra: typing
Requires-Dist: mypy ; extra == 'typing'

PYTHON OBJECT GETTER

Import something from a module, while mocking anything in its namespace.

.. start-badges

| |build| |release_version| |wheel| |supported_versions| |gh-lic| |commits_since_specific_tag_on_master| |commits_since_latest_github_release|


|
| **Source Code:** https://github.com/boromir674/python-object-getter
| **Pypi Package:** https://pypi.org/project/python_object_getter/
|


Features
========


1. **python_object_getter** `python package`

   a. **Great Feature**
   b. **Nice Feature**

2. **Test Suite** using `Pytest`
3. **Parallel Execution** of Unit Tests, on multiple cpu's
4. **Automation**, using `tox`

   a. **Code Coverage** measuring
   b. **Build Command**, using the `build` python package
   c. **Pypi Deploy Command**, supporting upload to both `pypi.org` and `test.pypi.org` servers
   d. **Type Check Command**, using `mypy`
5. **CI Pipeline**, running on `Github Actions`

   a. **Job Matrix**, spanning different `platform`'s and `python version`'s

      1. Platforms: `ubuntu-latest`, `macos-latest`
      2. Python Iterpreters: `3.6`, `3.7`, `3.8`, `3.9`, `3.10`
   b. **Parallel Job** execution, generated from the `matrix`, that runs the `Test Suite`


Prerequisites
=============

You need to have `Python` installed.

Quickstart
==========

Using `pip` is the approved way for installing `python_object_getter`.

.. code-block:: sh

    python3 -m pip install python_object_getter


TODO demonstrate a use case


License
=======

|gh-lic|

* `GNU Affero General Public License v3.0`_


License
=======

* Free software: GNU Affero General Public License v3.0


.. MACROS/ALIASES

.. start-badges

.. Test Workflow Status on Github Actions for specific branch <branch>

.. |build| image:: https://img.shields.io/github/workflow/status/boromir674/python-object-getter/Test%20Python%20Package/master?label=build&logo=github-actions&logoColor=%233392FF
    :alt: GitHub Workflow Status (branch)
    :target: https://github.com/boromir674/python-object-getter/actions/workflows/test.yaml?query=branch%3Amaster

.. above url to workflow runs, filtered by the specified branch

.. |release_version| image:: https://img.shields.io/pypi/v/python_object_getter
    :alt: Production Version
    :target: https://pypi.org/project/python_object_getter/

.. |wheel| image:: https://img.shields.io/pypi/wheel/python-object-getter?color=green&label=wheel
    :alt: PyPI - Wheel
    :target: https://pypi.org/project/python_object_getter

.. |supported_versions| image:: https://img.shields.io/pypi/pyversions/python-object-getter?color=blue&label=python&logo=python&logoColor=%23ccccff
    :alt: Supported Python versions
    :target: https://pypi.org/project/python_object_getter

.. |commits_since_specific_tag_on_master| image:: https://img.shields.io/github/commits-since/boromir674/python-object-getter/v0.0.2/master?color=blue&logo=github
    :alt: GitHub commits since tagged version (branch)
    :target: https://github.com/boromir674/python-object-getter/compare/v0.0.2..master

.. |commits_since_latest_github_release| image:: https://img.shields.io/github/commits-since/boromir674/python-object-getter/latest?color=blue&logo=semver&sort=semver
    :alt: GitHub commits since latest release (by SemVer)

.. Github License (eg AGPL, MIT)
.. |gh-lic| image:: https://img.shields.io/github/license/boromir674/python-object-getter
    :alt: GitHub
    :target: https://github.com/boromir674/python-object-getter/blob/master/LICENSE


.. LINKS

.. _GNU Affero General Public License v3.0: https://github.com/boromir674/python-object-getter/blob/master/LICENSE


