orthogonal-cli


Nameorthogonal-cli JSON
Version 0.2.0 PyPI version JSON
download
home_pagehttps://github.com/crunchdao/orthogonal-cli
Summaryorthogonal-cli - CLI of the Orthogonal CrunchDAO Platform
upload_time2023-09-01 17:59:18
maintainer
docs_urlNone
authorEnzo CACERES
requires_python>=3
license
keywords package development template
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Orthogonal CLI

## Installation

Use [pip](https://pypi.org/project/orthogonal-cli/) to install the `orthogonal-cli`.

```bash
pip install orthogonal-cli --upgrade
```

## Usage

This library require a [CrunchDAO's API Key](https://account.crunchdao.com/account/api).

```python
import orthogonal

client = orthogonal.Client(
    api_key="..." # can also be read from CRUNCHDAO_API_KEY environment variable.
)

y = pandas.read_csv("y.csv", index_col=0)
print(y.head())
#                date  symbol       abcd
# 1030371  2023-01-06  AAAAAAA -2.122527
# 1030372  2023-01-06  BBBBBBB -0.386952
# 1030373  2023-01-06  CCCCCCC  0.028175
# 1030374  2023-01-06  DDDDDDD -1.276682
# 1030375  2023-01-06  EEEEEEE  0.939289

dataframe = client.orthogonalize(y)
print(dataframe.head())
#          date  symbol       abcd
# 0  2023-01-06  AAAAAAA -2.149988
# 1  2023-01-06  BBBBBBB -0.395232
# 2  2023-01-06  CCCCCCC  0.030502
# 3  2023-01-06  DDDDDDD -1.311531
# 4  2023-01-06  EEEEEEE  0.917134
```

## Contributing

Pull requests are always welcome! If you find any issues or have suggestions for improvements, please feel free to submit a pull request or open an issue in the GitHub repository.

## License

[MIT](https://choosealicense.com/licenses/mit/)

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/crunchdao/orthogonal-cli",
    "name": "orthogonal-cli",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3",
    "maintainer_email": "",
    "keywords": "package development template",
    "author": "Enzo CACERES",
    "author_email": "enzo.caceres@crunchdao.com",
    "download_url": "https://files.pythonhosted.org/packages/56/9d/529b066b51dff9ed4591c01a771cacda2d2e6048360226293cb9041c2e99/orthogonal-cli-0.2.0.tar.gz",
    "platform": null,
    "description": "# Orthogonal CLI\n\n## Installation\n\nUse [pip](https://pypi.org/project/orthogonal-cli/) to install the `orthogonal-cli`.\n\n```bash\npip install orthogonal-cli --upgrade\n```\n\n## Usage\n\nThis library require a [CrunchDAO's API Key](https://account.crunchdao.com/account/api).\n\n```python\nimport orthogonal\n\nclient = orthogonal.Client(\n    api_key=\"...\" # can also be read from CRUNCHDAO_API_KEY environment variable.\n)\n\ny = pandas.read_csv(\"y.csv\", index_col=0)\nprint(y.head())\n#                date  symbol       abcd\n# 1030371  2023-01-06  AAAAAAA -2.122527\n# 1030372  2023-01-06  BBBBBBB -0.386952\n# 1030373  2023-01-06  CCCCCCC  0.028175\n# 1030374  2023-01-06  DDDDDDD -1.276682\n# 1030375  2023-01-06  EEEEEEE  0.939289\n\ndataframe = client.orthogonalize(y)\nprint(dataframe.head())\n#          date  symbol       abcd\n# 0  2023-01-06  AAAAAAA -2.149988\n# 1  2023-01-06  BBBBBBB -0.395232\n# 2  2023-01-06  CCCCCCC  0.030502\n# 3  2023-01-06  DDDDDDD -1.311531\n# 4  2023-01-06  EEEEEEE  0.917134\n```\n\n## Contributing\n\nPull requests are always welcome! If you find any issues or have suggestions for improvements, please feel free to submit a pull request or open an issue in the GitHub repository.\n\n## License\n\n[MIT](https://choosealicense.com/licenses/mit/)\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "orthogonal-cli - CLI of the Orthogonal CrunchDAO Platform",
    "version": "0.2.0",
    "project_urls": {
        "Homepage": "https://github.com/crunchdao/orthogonal-cli"
    },
    "split_keywords": [
        "package",
        "development",
        "template"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e0947da023659b96775c2c65e133eedf5bf24e0d36d52c0213d0d739b331f1e2",
                "md5": "ab134c3124a28921005ad7addcb03101",
                "sha256": "99cab77d2db6d3b95224e88647757bcd90d64a1e99356f58ce76cf97c31f4407"
            },
            "downloads": -1,
            "filename": "orthogonal_cli-0.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ab134c3124a28921005ad7addcb03101",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3",
            "size": 3595,
            "upload_time": "2023-09-01T17:59:17",
            "upload_time_iso_8601": "2023-09-01T17:59:17.255082Z",
            "url": "https://files.pythonhosted.org/packages/e0/94/7da023659b96775c2c65e133eedf5bf24e0d36d52c0213d0d739b331f1e2/orthogonal_cli-0.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "569d529b066b51dff9ed4591c01a771cacda2d2e6048360226293cb9041c2e99",
                "md5": "eebd5cfa6a1ad4d4e67d9f1207c87797",
                "sha256": "a9e3290745a3e75ffc69b489c330e12243da0749ddf90ddfe36b720d74d87bf4"
            },
            "downloads": -1,
            "filename": "orthogonal-cli-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "eebd5cfa6a1ad4d4e67d9f1207c87797",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3",
            "size": 2947,
            "upload_time": "2023-09-01T17:59:18",
            "upload_time_iso_8601": "2023-09-01T17:59:18.680949Z",
            "url": "https://files.pythonhosted.org/packages/56/9d/529b066b51dff9ed4591c01a771cacda2d2e6048360226293cb9041c2e99/orthogonal-cli-0.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-09-01 17:59:18",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "crunchdao",
    "github_project": "orthogonal-cli",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "orthogonal-cli"
}
        
Elapsed time: 0.48722s