# Atomic Tessellator - CLI package
## Installation
```
pip install atomict
# install utils package with scientific extensions (ase, spglib)
pip install atomict[utils]
```
## Installation for devs
```
pip install -e ".[dev]"
```
Enable verbose logging for debugging:
```
export AT_DEBUG=enabled
```
# CLI Usage
## Get a list of available commands
```$ at```
You can get help for each command with `at <command> --help`. This will print the command-specific help and options.
## Log in and store authentication token
```$ at login```
This will prompt you for your username and password.
## Get a list of available projects
```$ at project get```
## Get a list of adsorbates
```$ at adsorbate get```
## Search objects for substrings
```$ at adsorbate get --search NH3```
## Get a list of tasks
```$ at task get```
## Get tasks with a specific status
```$ at task get --status completed```
## Configuration
Tab completion is available. Run the hidden command:
```at completion```
This will print out the instructions for enabling tab completion for your shell.
Raw data
{
"_id": null,
"home_page": null,
"name": "atomict",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "atomic, tessellator, cli, client, fhi-aims, kpoint, sqs, adsorbate",
"author": null,
"author_email": "Steven Anderson <steven@atomictessellator.com>, Alain Richardt <alain@atomictessellator.com>",
"download_url": "https://files.pythonhosted.org/packages/33/c3/41cb5f21c3ecbde0c29876e70ba6e5f4c5d43496bbf5b8215b8c8c7055ee/atomict-0.2.4.tar.gz",
"platform": null,
"description": "# Atomic Tessellator - CLI package\n\n## Installation\n```\npip install atomict\n\n# install utils package with scientific extensions (ase, spglib) \npip install atomict[utils]\n```\n\n## Installation for devs\n```\npip install -e \".[dev]\"\n```\n\nEnable verbose logging for debugging:\n\n```\nexport AT_DEBUG=enabled\n```\n\n# CLI Usage\n\n## Get a list of available commands\n\n```$ at```\n\n![Alt text](img/at.png?raw=true \"at\")\n\nYou can get help for each command with `at <command> --help`. This will print the command-specific help and options.\n## Log in and store authentication token\n\n```$ at login```\n\nThis will prompt you for your username and password.\n\n\n## Get a list of available projects\n\n```$ at project get```\n\n![Alt text](img/at_project_get.png?raw=true \"at project get\")\n\n\n## Get a list of adsorbates\n\n```$ at adsorbate get```\n\n![Alt text](img/at_adsorbate_get.png?raw=true \"at adsorbate get\")\n\n## Search objects for substrings\n\n```$ at adsorbate get --search NH3```\n\n![Alt text](img/at_adsorbate_get_search.png?raw=true \"at adsorbate get --search\")\n\n## Get a list of tasks\n\n```$ at task get```\n\n![Alt text](img/at_task_get.png?raw=true \"at task get\")\n\n## Get tasks with a specific status\n\n```$ at task get --status completed```\n\n![Alt text](img/at_task_get_completed.png?raw=true \"at task get --status completed\")\n\n## Configuration\n\nTab completion is available. Run the hidden command:\n\n```at completion```\n\nThis will print out the instructions for enabling tab completion for your shell.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "The client application for the https://atomictessellator.com/",
"version": "0.2.4",
"project_urls": {
"Homepage": "https://github.com/AtomicTessellator/atomic_cli"
},
"split_keywords": [
"atomic",
" tessellator",
" cli",
" client",
" fhi-aims",
" kpoint",
" sqs",
" adsorbate"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8b437c306517aa60e139e7d3e57629196524ac575521b9e783cd446d35b75343",
"md5": "cc5c375ec3226d4aeab2626896521804",
"sha256": "29132ff6376e1d4c57d9c1b3f6bf056744517b09c17ba143fa3583469ef7f21d"
},
"downloads": -1,
"filename": "atomict-0.2.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cc5c375ec3226d4aeab2626896521804",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 66832,
"upload_time": "2025-02-19T23:09:24",
"upload_time_iso_8601": "2025-02-19T23:09:24.265790Z",
"url": "https://files.pythonhosted.org/packages/8b/43/7c306517aa60e139e7d3e57629196524ac575521b9e783cd446d35b75343/atomict-0.2.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "33c341cb5f21c3ecbde0c29876e70ba6e5f4c5d43496bbf5b8215b8c8c7055ee",
"md5": "cd7e693f0a2345b5ebf254305b09bf93",
"sha256": "ad38b2f8036991184f24a84ad59f3d62abb6015f53d6212f08639b5423c21471"
},
"downloads": -1,
"filename": "atomict-0.2.4.tar.gz",
"has_sig": false,
"md5_digest": "cd7e693f0a2345b5ebf254305b09bf93",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 42032,
"upload_time": "2025-02-19T23:09:28",
"upload_time_iso_8601": "2025-02-19T23:09:28.492233Z",
"url": "https://files.pythonhosted.org/packages/33/c3/41cb5f21c3ecbde0c29876e70ba6e5f4c5d43496bbf5b8215b8c8c7055ee/atomict-0.2.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-19 23:09:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "AtomicTessellator",
"github_project": "atomic_cli",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "requests",
"specs": []
},
{
"name": "tenacity",
"specs": [
[
"~=",
"9.0"
]
]
},
{
"name": "httpx",
"specs": []
},
{
"name": "click",
"specs": [
[
"~=",
"8.0"
]
]
},
{
"name": "rich",
"specs": [
[
"~=",
"13.0"
]
]
}
],
"lcname": "atomict"
}
JSON
