# Atomic Tessellator - CLI package
## Installation
```
pip install atomict
# install utils package with scientific extensions (ase, spglib)
pip install atomict[utils]
# ", with a git url
pip install git+https://github.com/AtomicTessellator/atomic_cli#egg=atomict[utils]
# Troubleshooting
If pip install is not working, try:
pip install --upgrade setuptools pip wheel
```
## Installation for devs
```
pip install -e ".[dev]"
```
Enable verbose logging for debugging:
```
export AT_DEBUG=enabled
```
# CLI Usage
## Get a list of available commands
```$ tess```
You can get help for each command with `tess <command> --help`. This will print the command-specific help and options.
## Log in and store authentication token
```$ tess login```
This will prompt you for your username and password.
## Get a list of available projects
```$ tess project get```
## Get a list of adsorbates
```$ tess adsorbate get```
## Search objects for substrings
```$ tess adsorbate get --search NH3```
## Get a list of tasks
```$ tess task get```
## Get tasks with a specific status
```$ tess task get --status completed```
## Configuration
Tab completion is available. Run the hidden command:
```tess 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/e8/9b/97eea31033af5c4724f46b348152157cb93ba24b9743d3b022bd7811f60e/atomict-1.2.15.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# \", with a git url\npip install git+https://github.com/AtomicTessellator/atomic_cli#egg=atomict[utils]\n\n# Troubleshooting\nIf pip install is not working, try:\npip install --upgrade setuptools pip wheel\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```$ tess```\n\n![Alt text](img/at.png?raw=true \"at\")\n\nYou can get help for each command with `tess <command> --help`. This will print the command-specific help and options.\n## Log in and store authentication token\n\n```$ tess login```\n\nThis will prompt you for your username and password.\n\n\n## Get a list of available projects\n\n```$ tess project get```\n\n![Alt text](img/at_project_get.png?raw=true \"tess project get\")\n\n\n## Get a list of adsorbates\n\n```$ tess adsorbate get```\n\n![Alt text](img/at_adsorbate_get.png?raw=true \"tess adsorbate get\")\n\n## Search objects for substrings\n\n```$ tess adsorbate get --search NH3```\n\n![Alt text](img/at_adsorbate_get_search.png?raw=true \"tess adsorbate get --search\")\n\n## Get a list of tasks\n\n```$ tess task get```\n\n![Alt text](img/at_task_get.png?raw=true \"tess task get\")\n\n## Get tasks with a specific status\n\n```$ tess task get --status completed```\n\n![Alt text](img/at_task_get_completed.png?raw=true \"tess task get --status completed\")\n\n## Configuration\n\nTab completion is available. Run the hidden command:\n\n```tess 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": "1.2.15",
"project_urls": {
"Homepage": "https://github.com/AtomicTessellator/atomic_cli"
},
"split_keywords": [
"atomic",
" tessellator",
" cli",
" client",
" fhi-aims",
" kpoint",
" sqs",
" adsorbate"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "f8602cf193db5de7705c18e7bc14c8f0bf6857482335b72f77eca58de54f2897",
"md5": "19a76adf1ae8205d360b1c456e3bb492",
"sha256": "a071f65e0381b5a665f3f1b713f64f9830b9dea775052f6aa96d95869f073d22"
},
"downloads": -1,
"filename": "atomict-1.2.15-py3-none-any.whl",
"has_sig": false,
"md5_digest": "19a76adf1ae8205d360b1c456e3bb492",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 90793,
"upload_time": "2025-07-25T11:53:06",
"upload_time_iso_8601": "2025-07-25T11:53:06.650585Z",
"url": "https://files.pythonhosted.org/packages/f8/60/2cf193db5de7705c18e7bc14c8f0bf6857482335b72f77eca58de54f2897/atomict-1.2.15-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "e89b97eea31033af5c4724f46b348152157cb93ba24b9743d3b022bd7811f60e",
"md5": "b1a9287330a207e1ddf99df2c101d599",
"sha256": "b95e4271e61eddd82e8b665d541f6e72ee4153b08955cd2a5a5f162b5f7a76e7"
},
"downloads": -1,
"filename": "atomict-1.2.15.tar.gz",
"has_sig": false,
"md5_digest": "b1a9287330a207e1ddf99df2c101d599",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 61386,
"upload_time": "2025-07-25T11:53:08",
"upload_time_iso_8601": "2025-07-25T11:53:08.181077Z",
"url": "https://files.pythonhosted.org/packages/e8/9b/97eea31033af5c4724f46b348152157cb93ba24b9743d3b022bd7811f60e/atomict-1.2.15.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-25 11:53:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "AtomicTessellator",
"github_project": "atomic_cli",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "requests",
"specs": []
},
{
"name": "tenacity",
"specs": [
[
"~=",
"9.0"
]
]
},
{
"name": "httpx",
"specs": []
},
{
"name": "click",
"specs": [
[
"~=",
"8.0"
]
]
},
{
"name": "rich",
"specs": [
[
"~=",
"13.0"
]
]
},
{
"name": "deepdiff",
"specs": []
}
],
"lcname": "atomict"
}
JSON
