# Akhenaten-py
Client to use the plotly hosting service at akhenaten.eu
This library can be used to upload Plotly plots to the akhenaten plotly hosting service!
To use this service first get an account by contacting frank (at) amunanalytics.eu
If you would like to use a GUI, simply use your client Id and key to login to https://console.akhenaten.eu
## Installation
`python3 -m pip install akhenaten-py`
## Usage
```python
import os
# authentication can be done with environment variables or directly
# this example shows both, this is just to show the possibilities!
os.environ['AKHENATEN_ID'] = '<your client ID>'
os.environ['AKHENATEN_KEY'] = '<your client key'
from akhenaten import AkhenatenClient
client_hoster = AkhenatenClient(
# not needed when using environment variables!
akhenaten_id ='<your client ID>',
akhenaten_key='<your client key>'
)
# get all current uploaded figs
print(client_hoster.list_figs())
# create some fig
fig = get_some_plotly_fig()
# upload it and display the urls
# if no slug is specified then a random uuid4 will be generated
result = client_hoster.upload_fig(fig, slug='<optional slug>')
print(result['json_url']) # the url to use in your own embedding
print(result['fig_url']) # direct html access
```
## Alternative usage
This service is backed by minio which is fully AWS S3 compatible.
Thus if you would like more extensive features you can use the ```boto3``` package.
The hosting url will then be https://s3.akheaten.eu/BUCKET_NAME/ITEM_NAME.json
Raw data
{
"_id": null,
"home_page": "https://github.com/AmunAnalytics/akhenaten-py",
"name": "akhenaten-py",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "Client for Akhenaten plotly hoster",
"author": "Frank Boerman",
"author_email": "frank@amunanalytics.eu",
"download_url": "https://files.pythonhosted.org/packages/ab/e2/cfb488bf28fdb36f16882c44f9c9d0e7bc5ee4c2e9f55313263b4533e8c2/akhenaten-py-0.1.0.tar.gz",
"platform": null,
"description": "# Akhenaten-py\n\nClient to use the plotly hosting service at akhenaten.eu\n\nThis library can be used to upload Plotly plots to the akhenaten plotly hosting service! \nTo use this service first get an account by contacting frank (at) amunanalytics.eu\n\nIf you would like to use a GUI, simply use your client Id and key to login to https://console.akhenaten.eu\n\n## Installation\n`python3 -m pip install akhenaten-py`\n\n## Usage\n```python\nimport os\n\n# authentication can be done with environment variables or directly\n# this example shows both, this is just to show the possibilities!\nos.environ['AKHENATEN_ID'] = '<your client ID>'\nos.environ['AKHENATEN_KEY'] = '<your client key'\n\nfrom akhenaten import AkhenatenClient\nclient_hoster = AkhenatenClient(\n # not needed when using environment variables!\n akhenaten_id ='<your client ID>',\n akhenaten_key='<your client key>'\n)\n# get all current uploaded figs\nprint(client_hoster.list_figs())\n\n# create some fig\nfig = get_some_plotly_fig()\n# upload it and display the urls\n# if no slug is specified then a random uuid4 will be generated\nresult = client_hoster.upload_fig(fig, slug='<optional slug>')\n\nprint(result['json_url']) # the url to use in your own embedding\nprint(result['fig_url']) # direct html access\n```\n\n## Alternative usage\nThis service is backed by minio which is fully AWS S3 compatible.\nThus if you would like more extensive features you can use the ```boto3``` package. \nThe hosting url will then be https://s3.akheaten.eu/BUCKET_NAME/ITEM_NAME.json\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A python API wrapper for Akhenaten Plotly hoster",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/AmunAnalytics/akhenaten-py"
},
"split_keywords": [
"client",
"for",
"akhenaten",
"plotly",
"hoster"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1d6075dd6446062bd8c6b196049a0059ef89c73d7fcb9fbbed999292cc162553",
"md5": "f77b4d9f323be0036d18858309e9cfe3",
"sha256": "10f600cf28c8f67f5b1cbca08c44cc544460e2d5e7da61343abc9fd08d325fc9"
},
"downloads": -1,
"filename": "akhenaten_py-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f77b4d9f323be0036d18858309e9cfe3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 3943,
"upload_time": "2023-08-31T21:24:47",
"upload_time_iso_8601": "2023-08-31T21:24:47.300465Z",
"url": "https://files.pythonhosted.org/packages/1d/60/75dd6446062bd8c6b196049a0059ef89c73d7fcb9fbbed999292cc162553/akhenaten_py-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "abe2cfb488bf28fdb36f16882c44f9c9d0e7bc5ee4c2e9f55313263b4533e8c2",
"md5": "c2227caf44d89702d0fc9d518cc74cc3",
"sha256": "6da57f7bff83bb501d0a4d5e0d653f687fec36e8c790a2c80a61660f638d30b9"
},
"downloads": -1,
"filename": "akhenaten-py-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "c2227caf44d89702d0fc9d518cc74cc3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3765,
"upload_time": "2023-08-31T21:24:50",
"upload_time_iso_8601": "2023-08-31T21:24:50.558290Z",
"url": "https://files.pythonhosted.org/packages/ab/e2/cfb488bf28fdb36f16882c44f9c9d0e7bc5ee4c2e9f55313263b4533e8c2/akhenaten-py-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-31 21:24:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "AmunAnalytics",
"github_project": "akhenaten-py",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "akhenaten-py"
}
JSON
