======
apeye
======
.. start short_desc
**Handy tools for working with URLs and APIs.**
.. end short_desc
.. start shields
.. list-table::
:stub-columns: 1
:widths: 10 90
* - Docs
- |docs| |docs_check|
* - Tests
- |actions_linux| |actions_windows| |actions_macos| |coveralls|
* - PyPI
- |pypi-version| |supported-versions| |supported-implementations| |wheel|
* - Anaconda
- |conda-version| |conda-platform|
* - Activity
- |commits-latest| |commits-since| |maintained| |pypi-downloads|
* - QA
- |codefactor| |actions_flake8| |actions_mypy|
* - Other
- |license| |language| |requires|
.. |docs| image:: https://img.shields.io/readthedocs/apeye/latest?logo=read-the-docs
:target: https://apeye.readthedocs.io/en/latest
:alt: Documentation Build Status
.. |docs_check| image:: https://github.com/domdfcoding/apeye/workflows/Docs%20Check/badge.svg
:target: https://github.com/domdfcoding/apeye/actions?query=workflow%3A%22Docs+Check%22
:alt: Docs Check Status
.. |actions_linux| image:: https://github.com/domdfcoding/apeye/workflows/Linux/badge.svg
:target: https://github.com/domdfcoding/apeye/actions?query=workflow%3A%22Linux%22
:alt: Linux Test Status
.. |actions_windows| image:: https://github.com/domdfcoding/apeye/workflows/Windows/badge.svg
:target: https://github.com/domdfcoding/apeye/actions?query=workflow%3A%22Windows%22
:alt: Windows Test Status
.. |actions_macos| image:: https://github.com/domdfcoding/apeye/workflows/macOS/badge.svg
:target: https://github.com/domdfcoding/apeye/actions?query=workflow%3A%22macOS%22
:alt: macOS Test Status
.. |actions_flake8| image:: https://github.com/domdfcoding/apeye/workflows/Flake8/badge.svg
:target: https://github.com/domdfcoding/apeye/actions?query=workflow%3A%22Flake8%22
:alt: Flake8 Status
.. |actions_mypy| image:: https://github.com/domdfcoding/apeye/workflows/mypy/badge.svg
:target: https://github.com/domdfcoding/apeye/actions?query=workflow%3A%22mypy%22
:alt: mypy status
.. |requires| image:: https://dependency-dash.repo-helper.uk/github/domdfcoding/apeye/badge.svg
:target: https://dependency-dash.repo-helper.uk/github/domdfcoding/apeye/
:alt: Requirements Status
.. |coveralls| image:: https://img.shields.io/coveralls/github/domdfcoding/apeye/master?logo=coveralls
:target: https://coveralls.io/github/domdfcoding/apeye?branch=master
:alt: Coverage
.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/domdfcoding/apeye?logo=codefactor
:target: https://www.codefactor.io/repository/github/domdfcoding/apeye
:alt: CodeFactor Grade
.. |pypi-version| image:: https://img.shields.io/pypi/v/apeye
:target: https://pypi.org/project/apeye/
:alt: PyPI - Package Version
.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/apeye?logo=python&logoColor=white
:target: https://pypi.org/project/apeye/
:alt: PyPI - Supported Python Versions
.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/apeye
:target: https://pypi.org/project/apeye/
:alt: PyPI - Supported Implementations
.. |wheel| image:: https://img.shields.io/pypi/wheel/apeye
:target: https://pypi.org/project/apeye/
:alt: PyPI - Wheel
.. |conda-version| image:: https://img.shields.io/conda/v/domdfcoding/apeye?logo=anaconda
:target: https://anaconda.org/domdfcoding/apeye
:alt: Conda - Package Version
.. |conda-platform| image:: https://img.shields.io/conda/pn/domdfcoding/apeye?label=conda%7Cplatform
:target: https://anaconda.org/domdfcoding/apeye
:alt: Conda - Platform
.. |license| image:: https://img.shields.io/github/license/domdfcoding/apeye
:target: https://github.com/domdfcoding/apeye/blob/master/LICENSE
:alt: License
.. |language| image:: https://img.shields.io/github/languages/top/domdfcoding/apeye
:alt: GitHub top language
.. |commits-since| image:: https://img.shields.io/github/commits-since/domdfcoding/apeye/v1.4.1
:target: https://github.com/domdfcoding/apeye/pulse
:alt: GitHub commits since tagged version
.. |commits-latest| image:: https://img.shields.io/github/last-commit/domdfcoding/apeye
:target: https://github.com/domdfcoding/apeye/commit/master
:alt: GitHub last commit
.. |maintained| image:: https://img.shields.io/maintenance/yes/2023
:alt: Maintenance
.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/apeye
:target: https://pypi.org/project/apeye/
:alt: PyPI - Downloads
.. end shields
``apeye`` provides:
* ``pathlib.Path``\-like objects to represent URLs
* a JSON-backed cache decorator for functions
* a CacheControl_ adapter to limit the rate of requests
See `the documentation`_ for more details.
.. _CacheControl: https://github.com/ionrock/cachecontrol
.. _the documentation: https://apeye.readthedocs.io/en/latest/api/cache.html
Installation
--------------
.. start installation
``apeye`` can be installed from PyPI or Anaconda.
To install with ``pip``:
.. code-block:: bash
$ python -m pip install apeye
To install with ``conda``:
* First add the required channels
.. code-block:: bash
$ conda config --add channels https://conda.anaconda.org/conda-forge
$ conda config --add channels https://conda.anaconda.org/domdfcoding
* Then install
.. code-block:: bash
$ conda install apeye
.. end installation
.. attention::
In v0.9.0 and above the ``rate_limiter`` module requires the ``limiter`` extra to be installed:
.. code-block:: bash
$ python -m pip install apeye[limiter]
Raw data
{
"_id": null,
"home_page": "",
"name": "apeye",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6.1",
"maintainer_email": "",
"keywords": "api,cache,requests,rest,url",
"author": "",
"author_email": "Dominic Davis-Foster <dominic@davis-foster.co.uk>",
"download_url": "https://files.pythonhosted.org/packages/4f/6b/cc65e31843d7bfda8313a9dc0c77a21e8580b782adca53c7cb3e511fe023/apeye-1.4.1.tar.gz",
"platform": null,
"description": "======\napeye\n======\n\n.. start short_desc\n\n**Handy tools for working with URLs and APIs.**\n\n.. end short_desc\n\n\n.. start shields\n\n.. list-table::\n\t:stub-columns: 1\n\t:widths: 10 90\n\n\t* - Docs\n\t - |docs| |docs_check|\n\t* - Tests\n\t - |actions_linux| |actions_windows| |actions_macos| |coveralls|\n\t* - PyPI\n\t - |pypi-version| |supported-versions| |supported-implementations| |wheel|\n\t* - Anaconda\n\t - |conda-version| |conda-platform|\n\t* - Activity\n\t - |commits-latest| |commits-since| |maintained| |pypi-downloads|\n\t* - QA\n\t - |codefactor| |actions_flake8| |actions_mypy|\n\t* - Other\n\t - |license| |language| |requires|\n\n.. |docs| image:: https://img.shields.io/readthedocs/apeye/latest?logo=read-the-docs\n\t:target: https://apeye.readthedocs.io/en/latest\n\t:alt: Documentation Build Status\n\n.. |docs_check| image:: https://github.com/domdfcoding/apeye/workflows/Docs%20Check/badge.svg\n\t:target: https://github.com/domdfcoding/apeye/actions?query=workflow%3A%22Docs+Check%22\n\t:alt: Docs Check Status\n\n.. |actions_linux| image:: https://github.com/domdfcoding/apeye/workflows/Linux/badge.svg\n\t:target: https://github.com/domdfcoding/apeye/actions?query=workflow%3A%22Linux%22\n\t:alt: Linux Test Status\n\n.. |actions_windows| image:: https://github.com/domdfcoding/apeye/workflows/Windows/badge.svg\n\t:target: https://github.com/domdfcoding/apeye/actions?query=workflow%3A%22Windows%22\n\t:alt: Windows Test Status\n\n.. |actions_macos| image:: https://github.com/domdfcoding/apeye/workflows/macOS/badge.svg\n\t:target: https://github.com/domdfcoding/apeye/actions?query=workflow%3A%22macOS%22\n\t:alt: macOS Test Status\n\n.. |actions_flake8| image:: https://github.com/domdfcoding/apeye/workflows/Flake8/badge.svg\n\t:target: https://github.com/domdfcoding/apeye/actions?query=workflow%3A%22Flake8%22\n\t:alt: Flake8 Status\n\n.. |actions_mypy| image:: https://github.com/domdfcoding/apeye/workflows/mypy/badge.svg\n\t:target: https://github.com/domdfcoding/apeye/actions?query=workflow%3A%22mypy%22\n\t:alt: mypy status\n\n.. |requires| image:: https://dependency-dash.repo-helper.uk/github/domdfcoding/apeye/badge.svg\n\t:target: https://dependency-dash.repo-helper.uk/github/domdfcoding/apeye/\n\t:alt: Requirements Status\n\n.. |coveralls| image:: https://img.shields.io/coveralls/github/domdfcoding/apeye/master?logo=coveralls\n\t:target: https://coveralls.io/github/domdfcoding/apeye?branch=master\n\t:alt: Coverage\n\n.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/domdfcoding/apeye?logo=codefactor\n\t:target: https://www.codefactor.io/repository/github/domdfcoding/apeye\n\t:alt: CodeFactor Grade\n\n.. |pypi-version| image:: https://img.shields.io/pypi/v/apeye\n\t:target: https://pypi.org/project/apeye/\n\t:alt: PyPI - Package Version\n\n.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/apeye?logo=python&logoColor=white\n\t:target: https://pypi.org/project/apeye/\n\t:alt: PyPI - Supported Python Versions\n\n.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/apeye\n\t:target: https://pypi.org/project/apeye/\n\t:alt: PyPI - Supported Implementations\n\n.. |wheel| image:: https://img.shields.io/pypi/wheel/apeye\n\t:target: https://pypi.org/project/apeye/\n\t:alt: PyPI - Wheel\n\n.. |conda-version| image:: https://img.shields.io/conda/v/domdfcoding/apeye?logo=anaconda\n\t:target: https://anaconda.org/domdfcoding/apeye\n\t:alt: Conda - Package Version\n\n.. |conda-platform| image:: https://img.shields.io/conda/pn/domdfcoding/apeye?label=conda%7Cplatform\n\t:target: https://anaconda.org/domdfcoding/apeye\n\t:alt: Conda - Platform\n\n.. |license| image:: https://img.shields.io/github/license/domdfcoding/apeye\n\t:target: https://github.com/domdfcoding/apeye/blob/master/LICENSE\n\t:alt: License\n\n.. |language| image:: https://img.shields.io/github/languages/top/domdfcoding/apeye\n\t:alt: GitHub top language\n\n.. |commits-since| image:: https://img.shields.io/github/commits-since/domdfcoding/apeye/v1.4.1\n\t:target: https://github.com/domdfcoding/apeye/pulse\n\t:alt: GitHub commits since tagged version\n\n.. |commits-latest| image:: https://img.shields.io/github/last-commit/domdfcoding/apeye\n\t:target: https://github.com/domdfcoding/apeye/commit/master\n\t:alt: GitHub last commit\n\n.. |maintained| image:: https://img.shields.io/maintenance/yes/2023\n\t:alt: Maintenance\n\n.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/apeye\n\t:target: https://pypi.org/project/apeye/\n\t:alt: PyPI - Downloads\n\n.. end shields\n\n``apeye`` provides:\n\n* ``pathlib.Path``\\-like objects to represent URLs\n* a JSON-backed cache decorator for functions\n* a CacheControl_ adapter to limit the rate of requests\n\nSee `the documentation`_ for more details.\n\n.. _CacheControl: https://github.com/ionrock/cachecontrol\n.. _the documentation: https://apeye.readthedocs.io/en/latest/api/cache.html\n\nInstallation\n--------------\n\n.. start installation\n\n``apeye`` can be installed from PyPI or Anaconda.\n\nTo install with ``pip``:\n\n.. code-block:: bash\n\n\t$ python -m pip install apeye\n\nTo install with ``conda``:\n\n\t* First add the required channels\n\n\t.. code-block:: bash\n\n\t\t$ conda config --add channels https://conda.anaconda.org/conda-forge\n\t\t$ conda config --add channels https://conda.anaconda.org/domdfcoding\n\n\t* Then install\n\n\t.. code-block:: bash\n\n\t\t$ conda install apeye\n\n.. end installation\n\n\n.. attention::\n\n\tIn v0.9.0 and above the ``rate_limiter`` module requires the ``limiter`` extra to be installed:\n\n\t.. code-block:: bash\n\n\t\t$ python -m pip install apeye[limiter]\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Handy tools for working with URLs and APIs.",
"version": "1.4.1",
"project_urls": {
"Documentation": "https://apeye.readthedocs.io/en/latest",
"Homepage": "https://github.com/domdfcoding/apeye",
"Issue Tracker": "https://github.com/domdfcoding/apeye/issues",
"Source Code": "https://github.com/domdfcoding/apeye"
},
"split_keywords": [
"api",
"cache",
"requests",
"rest",
"url"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "897b2d63664777b3e831ac1b1d8df5bbf0b7c8bee48e57115896080890527b1b",
"md5": "0bab407691ad0f272349894cdde2b774",
"sha256": "44e58a9104ec189bf42e76b3a7fe91e2b2879d96d48e9a77e5e32ff699c9204e"
},
"downloads": -1,
"filename": "apeye-1.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0bab407691ad0f272349894cdde2b774",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6.1",
"size": 107989,
"upload_time": "2023-08-14T15:32:40",
"upload_time_iso_8601": "2023-08-14T15:32:40.064681Z",
"url": "https://files.pythonhosted.org/packages/89/7b/2d63664777b3e831ac1b1d8df5bbf0b7c8bee48e57115896080890527b1b/apeye-1.4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4f6bcc65e31843d7bfda8313a9dc0c77a21e8580b782adca53c7cb3e511fe023",
"md5": "5ec1415a8df9232d5b41ecbc0b9f2b78",
"sha256": "14ea542fad689e3bfdbda2189a354a4908e90aee4bf84c15ab75d68453d76a36"
},
"downloads": -1,
"filename": "apeye-1.4.1.tar.gz",
"has_sig": false,
"md5_digest": "5ec1415a8df9232d5b41ecbc0b9f2b78",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6.1",
"size": 99219,
"upload_time": "2023-08-14T15:32:41",
"upload_time_iso_8601": "2023-08-14T15:32:41.381331Z",
"url": "https://files.pythonhosted.org/packages/4f/6b/cc65e31843d7bfda8313a9dc0c77a21e8580b782adca53c7cb3e511fe023/apeye-1.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-14 15:32:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "domdfcoding",
"github_project": "apeye",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "apeye-core",
"specs": [
[
">=",
"1.0.0b2"
]
]
},
{
"name": "domdf-python-tools",
"specs": [
[
">=",
"2.6.0"
]
]
},
{
"name": "platformdirs",
"specs": [
[
">=",
"2.3.0"
]
]
},
{
"name": "requests",
"specs": [
[
">=",
"2.24.0"
]
]
}
],
"tox": true,
"lcname": "apeye"
}
JSON
