currensees-sdk


Namecurrensees-sdk JSON
Version 1.0.0 PyPI version JSON
download
home_pagehttps://moatsystems.com/currency-api/
SummaryPython library for integrating with the Currency API.
upload_time2023-04-05 02:58:24
maintainer
docs_urlNone
authorMoat Systems Limited
requires_python>=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*
licenseBSD 3-Clause
keywords currency currency api currensees currensees sdk rate rates exchange rates moat moatsystems moat systems
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            currensees-sdk
==============

.. image:: https://badge.fury.io/py/currensees-sdk.svg
    :target: https://badge.fury.io/py/currensees-sdk
    :alt: Currency API Python Package Version

Python library for integrating with `Currency API`_ functionality.

.. _Currency API: https://moatsystems.com/currency-api/


Requirements
-------------

Python 2.7 and later.


Setup
------

You can install this package by using the pip tool and installing:

.. code-block:: bash

	$ pip install currensees-sdk

Or:

.. code-block:: bash

	$ easy_install currensees-sdk


Usage Example
-------------

.. code-block:: python

    from currensees-sdk.auth import CurrenseesAuth
    from currensees-sdk.convert import CurrenseesConvert
    from currensees-sdk.convert_all import CurrenseesConvertAll
    from currensees-sdk.currencies import CurrenseesCurrencies
    from currensees-sdk.historical import CurrenseesHistorical

    # Replace 'username' and 'password' with your actual credentials
    username = 'username'
    password = 'password'

    # Authenticate and log in
    auth_client = CurrenseesAuth(username, password)
    response = auth_client.login()

    # Use the base_url from the auth_client instance
    base_url = auth_client.base_url

    # Convert between two currencies
    convert_client = CurrenseesConvert(base_url)
    convert_response = convert_client.convert('2023_04_02', 'GBP', 'CAD', 500)
    print("Convert response:", convert_response)

    # Convert to all currencies
    convert_all_client = CurrenseesConvertAll(base_url)
    convert_all_response = convert_all_client.convert_all('GBP', 120, '2023_04_02')
    print("Convert All response:", convert_all_response)

    # Get all currencies
    currencies_client = CurrenseesCurrencies(base_url)
    currencies_response = currencies_client.get_currencies(username, '02', '04', '2023')
    print("Currencies response:", currencies_response)

    # Get currency by UUID
    # Replace '<uuid>' with a valid UUID for a currency
    uuid = '<uuid>'
    currency_by_uuid_response = currencies_client.get_currency_by_uuid(uuid, username, '02', '04', '2023')
    print("Currency by UUID response:", currency_by_uuid_response)

    # Get historical data
    historical_client = CurrenseesHistorical(base_url)
    historical_response = historical_client.get_historical_data(username, '2023_04_02', '02', '04', '2023')
    print("Historical response:", historical_response)

    # Get historical data by UUID
    # Replace '<uuid>' with a valid UUID for a currency
    uuid = '<uuid>'
    historical_data_by_uuid_response = historical_client.get_historical_data_by_uuid(uuid, username, '02', '04', '2023', '2023_04_02')
    print("Historical data by UUID response:", historical_data_by_uuid_response)


Setting up an Currency API Account
----------------------------------

Subscribe here for a `user account`_.

.. _user account: https://moatsystems.com/currency-api/


Using the Currency API
----------------------

You can read the `API documentation`_ to understand what's possible with the Currency API. If you need further assistance, don't hesitate to `contact us`_.

.. _API documentation: https://docs.currensees.com/
.. _contact us: https://moatsystems.com/contact/

License
--------

This project is licensed under the `BSD 3-Clause License`_.  

.. _BSD 3-Clause License: https://moatsystems.com/


Copyright
----------

Copyright |copy| 2023 `Moat Systems Limited`_. All Rights Reserved.

.. |copy| unicode:: 0xA9 .. copyright sign
.. _Moat Systems Limited: https://moatsystems.com/



            

Raw data

            {
    "_id": null,
    "home_page": "https://moatsystems.com/currency-api/",
    "name": "currensees-sdk",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*",
    "maintainer_email": "",
    "keywords": "currency,currency api,currensees,currensees sdk,rate,rates,exchange rates,moat,moatsystems,moat systems",
    "author": "Moat Systems Limited",
    "author_email": "support@moatsystems.com",
    "download_url": "https://files.pythonhosted.org/packages/32/dd/d76a61ad413ae7dcf24257f9e91762c4de05d57a7ef8774820dfc81aa035/currensees-sdk-1.0.0.tar.gz",
    "platform": null,
    "description": "currensees-sdk\n==============\n\n.. image:: https://badge.fury.io/py/currensees-sdk.svg\n    :target: https://badge.fury.io/py/currensees-sdk\n    :alt: Currency API Python Package Version\n\nPython library for integrating with `Currency API`_ functionality.\n\n.. _Currency API: https://moatsystems.com/currency-api/\n\n\nRequirements\n-------------\n\nPython 2.7 and later.\n\n\nSetup\n------\n\nYou can install this package by using the pip tool and installing:\n\n.. code-block:: bash\n\n\t$ pip install currensees-sdk\n\nOr:\n\n.. code-block:: bash\n\n\t$ easy_install currensees-sdk\n\n\nUsage Example\n-------------\n\n.. code-block:: python\n\n    from currensees-sdk.auth import CurrenseesAuth\n    from currensees-sdk.convert import CurrenseesConvert\n    from currensees-sdk.convert_all import CurrenseesConvertAll\n    from currensees-sdk.currencies import CurrenseesCurrencies\n    from currensees-sdk.historical import CurrenseesHistorical\n\n    # Replace 'username' and 'password' with your actual credentials\n    username = 'username'\n    password = 'password'\n\n    # Authenticate and log in\n    auth_client = CurrenseesAuth(username, password)\n    response = auth_client.login()\n\n    # Use the base_url from the auth_client instance\n    base_url = auth_client.base_url\n\n    # Convert between two currencies\n    convert_client = CurrenseesConvert(base_url)\n    convert_response = convert_client.convert('2023_04_02', 'GBP', 'CAD', 500)\n    print(\"Convert response:\", convert_response)\n\n    # Convert to all currencies\n    convert_all_client = CurrenseesConvertAll(base_url)\n    convert_all_response = convert_all_client.convert_all('GBP', 120, '2023_04_02')\n    print(\"Convert All response:\", convert_all_response)\n\n    # Get all currencies\n    currencies_client = CurrenseesCurrencies(base_url)\n    currencies_response = currencies_client.get_currencies(username, '02', '04', '2023')\n    print(\"Currencies response:\", currencies_response)\n\n    # Get currency by UUID\n    # Replace '<uuid>' with a valid UUID for a currency\n    uuid = '<uuid>'\n    currency_by_uuid_response = currencies_client.get_currency_by_uuid(uuid, username, '02', '04', '2023')\n    print(\"Currency by UUID response:\", currency_by_uuid_response)\n\n    # Get historical data\n    historical_client = CurrenseesHistorical(base_url)\n    historical_response = historical_client.get_historical_data(username, '2023_04_02', '02', '04', '2023')\n    print(\"Historical response:\", historical_response)\n\n    # Get historical data by UUID\n    # Replace '<uuid>' with a valid UUID for a currency\n    uuid = '<uuid>'\n    historical_data_by_uuid_response = historical_client.get_historical_data_by_uuid(uuid, username, '02', '04', '2023', '2023_04_02')\n    print(\"Historical data by UUID response:\", historical_data_by_uuid_response)\n\n\nSetting up an Currency API Account\n----------------------------------\n\nSubscribe here for a `user account`_.\n\n.. _user account: https://moatsystems.com/currency-api/\n\n\nUsing the Currency API\n----------------------\n\nYou can read the `API documentation`_ to understand what's possible with the Currency API. If you need further assistance, don't hesitate to `contact us`_.\n\n.. _API documentation: https://docs.currensees.com/\n.. _contact us: https://moatsystems.com/contact/\n\nLicense\n--------\n\nThis project is licensed under the `BSD 3-Clause License`_.  \n\n.. _BSD 3-Clause License: https://moatsystems.com/\n\n\nCopyright\n----------\n\nCopyright |copy| 2023 `Moat Systems Limited`_. All Rights Reserved.\n\n.. |copy| unicode:: 0xA9 .. copyright sign\n.. _Moat Systems Limited: https://moatsystems.com/\n\n\n",
    "bugtrack_url": null,
    "license": "BSD 3-Clause",
    "summary": "Python library for integrating with the Currency API.",
    "version": "1.0.0",
    "split_keywords": [
        "currency",
        "currency api",
        "currensees",
        "currensees sdk",
        "rate",
        "rates",
        "exchange rates",
        "moat",
        "moatsystems",
        "moat systems"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9b457b64fb2546c07d790e2ad32d82568314c17a33178f2bd3e81d34b155d75d",
                "md5": "4a26b6fc3be48cec606ed2fe969c7c1f",
                "sha256": "fcde2741c09331ea2e38eac7929523fda642505cfd6ad6afec68a82dcccd4e0e"
            },
            "downloads": -1,
            "filename": "currensees_sdk-1.0.0-py3.9.egg",
            "has_sig": false,
            "md5_digest": "4a26b6fc3be48cec606ed2fe969c7c1f",
            "packagetype": "bdist_egg",
            "python_version": "1.0.0",
            "requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*",
            "size": 9178,
            "upload_time": "2023-04-05T02:58:25",
            "upload_time_iso_8601": "2023-04-05T02:58:25.977142Z",
            "url": "https://files.pythonhosted.org/packages/9b/45/7b64fb2546c07d790e2ad32d82568314c17a33178f2bd3e81d34b155d75d/currensees_sdk-1.0.0-py3.9.egg",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3058045be70673f148c0ec30d8792a763a435cc6c8c8bc6d49f73da2a1e894fa",
                "md5": "2d762b6211c4b54487530fe3f1af022f",
                "sha256": "af362702033e192eb80e7e5a8924bc2e296427f63543925b2cc73dce36072102"
            },
            "downloads": -1,
            "filename": "currensees_sdk-1.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2d762b6211c4b54487530fe3f1af022f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*",
            "size": 6126,
            "upload_time": "2023-04-05T02:58:22",
            "upload_time_iso_8601": "2023-04-05T02:58:22.188377Z",
            "url": "https://files.pythonhosted.org/packages/30/58/045be70673f148c0ec30d8792a763a435cc6c8c8bc6d49f73da2a1e894fa/currensees_sdk-1.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "32ddd76a61ad413ae7dcf24257f9e91762c4de05d57a7ef8774820dfc81aa035",
                "md5": "47bdf7101b10413eb20f2ac4264e1859",
                "sha256": "2399268a16a92a755cb3de7018fe3041bfc93fadadd6fa32b8e377e474953065"
            },
            "downloads": -1,
            "filename": "currensees-sdk-1.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "47bdf7101b10413eb20f2ac4264e1859",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*",
            "size": 5329,
            "upload_time": "2023-04-05T02:58:24",
            "upload_time_iso_8601": "2023-04-05T02:58:24.160607Z",
            "url": "https://files.pythonhosted.org/packages/32/dd/d76a61ad413ae7dcf24257f9e91762c4de05d57a7ef8774820dfc81aa035/currensees-sdk-1.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-04-05 02:58:24",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "currensees-sdk"
}
        
Elapsed time: 0.18466s