| Name | periodic-table-cli JSON |
| Version |
2.1.1
JSON |
| download |
| home_page | |
| Summary | An interactive Periodic Table of Elements app for the console! |
| upload_time | 2024-02-25 17:29:15 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2023 Spiro Metaxas Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
periodic table
periodic table of elements
periodic
periodic-table-cli
chemistry
elements
atoms
atomic
cli
console
terminal
shell
unicode
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# periodic-table-cli
An interactive [Periodic Table of Elements](https://en.wikipedia.org/wiki/Periodic_table) app for the console!
Why the console? Because it's the *cool* way.
[](https://pypi.org/project/periodic-table-cli/)
[](https://pypi.org/project/periodic-table-cli/)
[](https://www.pepy.tech/projects/periodic-table-cli)
[](https://github.com/spirometaxas/periodic-table-cli-py/blob/main/LICENSE)
Also available for [NodeJS](https://www.npmjs.com/package/periodic-table-cli). View [Homepage](https://spirometaxas.com/projects/periodic-table-cli).
## Usage
```
$ pip install periodic-table-cli
$ periodic-table-cli
$ periodic-table-cli [options]
```
The config params are optional ([see below](https://github.com/spirometaxas/periodic-table-cli-py#options)).
Note: Supports Python 3.8+. Zero dependencies except [windows-curses](https://pypi.org/project/windows-curses/) for Windows.
### Interactive Controls
- **Navigation**: Use `UP` / `DOWN` / `LEFT` / `RIGHT` arrows.
- **Display Mode**: Use `SLASH` (`/`) to toggle the display mode forwards. Use `BACKSLASH` (` \ `) to toggle the display mode in reverse.
- **Search**: Use `UP` / `DOWN` arrows to navigate results. Press `ENTER` to select. Press `LEFT` to exit search.
- **Quit**: Press `ESC` or `CTRL+C`.
Add the `--help` flag for more info.
Note:
- Be sure to run in terminals that support 256 colors.
- Minimum required terminal screen dimensions: 156 columns x 46 rows. [See scrolling](https://github.com/spirometaxas/periodic-table-cli-py#scrolling) for more info.
## Features
### Browse
Use arrow keys to navigate and browse across all 118 elements. The selected element appears in gold on the Periodic Table on the left, and 22 data points for that element will display on the right. Each element's family and electron configuration will appear in gold below the Periodic Table.
Move the cursor directly below the Periodic Table to browse all 10 element families. The elements in that family will be focused on the Periodic Table, and a description of that family will appear on the right.
Move the cursor below the element families to browse all 4 electron configurations. The elements with that electron configuration will be focused on the Periodic Table, and a description of that electron shell will appear on the right.
### Search
Use letters or numbers to query for an element, family, or electron configuration. Queries are matched on element names, symbols, and atomic numbers, along with family names and electron configuration names. Just start typing to enter search mode. Press the Enter to select a search item, or the Left arrow to exit search mode.
### Display Mode
Use the SLASH (`/`) key to toggle different display modes. Use BACKSLASH (` \ `) to toggle in reverse. The following 20 display modes are supported:
#### Element Families
Display 10 color-coded element families:
#### Electron Configurations
Display 4 color-coded electron shells:
#### Standard State
Display whether an element is a solid (white), liquid (red), or gas (blue). Expected states appear as a darker color (gray is expected solid, dark blue is expected gas):
#### Atomic Mass
Display a heat-map of atomic mass (increasing from blue to red):
#### Protons
Display a heat-map of the number of protons (increasing from blue to red):
#### Neutrons
Display a heat-map of the number of neutrons (increasing from blue to red):
#### Electrons
Display a heat-map of the number of electrons (increasing from blue to red):
#### Valence Electrons
Display a color-coded representation of the number of valence electrons:
#### Valency
Display a color-coded representation of valency:
#### Atomic Radius
Display a heat-map of atomic radius (increasing from blue to red):
#### Density
Display a heat-map of density (increasing from blue to red):
#### Electronegativity
Display a heat-map of electronegativity (increasing from blue to red):
#### Ionization Energy
Display a heat-map of ionization energy (increasing from blue to red):
#### Electron Affinity
Display a heat-map of electron affinity (increasing from blue to red):
#### Melting Point
Display a heat-map of melting point (increasing from blue to red):
#### Boiling Point
Display a heat-map of boiling point (increasing from blue to red):
#### Specific Heat
Display a heat-map of specific heat (increasing from blue to red):
#### Radioactivity
Display which elements are radioactive (red) and stable (green):
#### Occurrence
Display which elements have a natural occurrence (blue), rare occurrence (orange), or artificial occurrence (yellow):
#### Year
Display a heat-map of the year each element was discovered (increasing from blue to red). Ancient elements appear in white:
## Options
### Data Mode
The `--mode=data` param displays a brief list of all the elements, including atomic number, element symbol, and element name:
```
$ periodic-table-cli --mode=data
```
#### Verbose
Add the optional `--verbose` flag (or shorthand `-v`) to display a detailed list of all elements with up to 27 data columns (limited by screen size):
```
$ periodic-table-cli --mode=data --verbose
```
#### Specific Elements
Specify an element to view data for that element. Elements can be specified using the `--atomic-number=<number>`, `--symbol=<symbol>`, or `--name=<name>` params:
```
$ periodic-table-cli --mode=data --atomic-number=<number>
$ periodic-table-cli --mode=data --symbol=<symbol>
$ periodic-table-cli --mode=data --name=<name>
```
### Chart Mode
The `--mode=chart` param prints a non-interactive Periodic Table of Elements:
```
$ periodic-table-cli --mode=chart
```
Minimum terminal width: 113 characters
#### Small
Add the optional `--small` flag (or shorthand `-s`) to print a smaller non-interactive version of the Periodic Table of Elements:
```
$ periodic-table-cli --mode=chart --small
```
Minimum terminal width: 76 characters
#### Specific Elements
Specify an element to view that element on the Periodic Table of Element. Elements can be specified using the `--atomic-number=<number>`, `--symbol=<symbol>`, or `--name=<name>` params:
```
$ periodic-table-cli --mode=chart --atomic-number=<number>
$ periodic-table-cli --mode=chart --symbol=<symbol>
$ periodic-table-cli --mode=chart --name=<name>
```
### App Mode (default)
The `--mode=app` param runs the app in interactive mode (default).
```
$ periodic-table-cli --mode=app
```
#### Specific Elements
Specify an element to launch the app on that element. Elements can be specified using the `--atomic-number=<number>`, `--symbol=<symbol>`, or `--name=<name>` params:
```
$ periodic-table-cli --mode=app --atomic-number=<number>
$ periodic-table-cli --mode=app --symbol=<symbol>
$ periodic-table-cli --mode=app --name=<name>
```
### Scrolling
The minimum required terminal screen dimensions are 156 columns x 46 rows. When using a smaller screen, some components may be cut off. To fix this, either make the screen bigger or use scrolling to pan across the screen:
- Use `COMMA` (`,`) to scroll up.
- Use `PERIOD` (`.`) to scroll down.
- Use `LEFT CARROT` (`<`) to scroll left.
- Use `RIGHT CARROT` (`>`) to scroll right.
## Data Sources
Data used in the app is stored in an easy to edit [data file](https://github.com/spirometaxas/periodic-table-cli-py/blob/main/periodic_table_cli/data.json). The data is mostly imported from [PubChem](https://pubchem.ncbi.nlm.nih.gov/periodic-table/).
Last Updated February 2024
## License
- [MIT](https://github.com/spirometaxas/periodic-table-cli-py/blob/main/LICENSE) © [Spiro Metaxas](https://spirometaxas.com)
Raw data
{
"_id": null,
"home_page": "",
"name": "periodic-table-cli",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "Spiro Metaxas <spirometaxas@outlook.com>",
"keywords": "Periodic Table,Periodic Table of Elements,periodic,periodic-table-cli,Chemistry,elements,atoms,atomic,cli,console,terminal,shell,unicode",
"author": "",
"author_email": "Spiro Metaxas <spirometaxas@outlook.com>",
"download_url": "https://files.pythonhosted.org/packages/da/da/9a2e8af1c993b06923e0bad3951ee5a8eabf61f90d56e35ce343043ea969/periodic-table-cli-2.1.1.tar.gz",
"platform": null,
"description": "# periodic-table-cli\r\n\r\n \r\n\r\nAn interactive [Periodic Table of Elements](https://en.wikipedia.org/wiki/Periodic_table) app for the console!\r\n\r\nWhy the console? Because it's the *cool* way.\r\n\r\n\r\n\r\n[](https://pypi.org/project/periodic-table-cli/)\r\n[](https://pypi.org/project/periodic-table-cli/)\r\n[](https://www.pepy.tech/projects/periodic-table-cli)\r\n[](https://github.com/spirometaxas/periodic-table-cli-py/blob/main/LICENSE)\r\n\r\nAlso available for [NodeJS](https://www.npmjs.com/package/periodic-table-cli). View [Homepage](https://spirometaxas.com/projects/periodic-table-cli).\r\n\r\n## Usage\r\n```\r\n$ pip install periodic-table-cli\r\n$ periodic-table-cli\r\n$ periodic-table-cli [options]\r\n```\r\n\r\nThe config params are optional ([see below](https://github.com/spirometaxas/periodic-table-cli-py#options)). \r\n\r\nNote: Supports Python 3.8+. Zero dependencies except [windows-curses](https://pypi.org/project/windows-curses/) for Windows.\r\n\r\n### Interactive Controls\r\n- **Navigation**: Use `UP` / `DOWN` / `LEFT` / `RIGHT` arrows.\r\n- **Display Mode**: Use `SLASH` (`/`) to toggle the display mode forwards. Use `BACKSLASH` (` \\ `) to toggle the display mode in reverse.\r\n- **Search**: Use `UP` / `DOWN` arrows to navigate results. Press `ENTER` to select. Press `LEFT` to exit search.\r\n- **Quit**: Press `ESC` or `CTRL+C`.\r\n\r\nAdd the `--help` flag for more info.\r\n\r\nNote:\r\n- Be sure to run in terminals that support 256 colors.\r\n- Minimum required terminal screen dimensions: 156 columns x 46 rows. [See scrolling](https://github.com/spirometaxas/periodic-table-cli-py#scrolling) for more info. \r\n\r\n## Features\r\n### Browse\r\nUse arrow keys to navigate and browse across all 118 elements. The selected element appears in gold on the Periodic Table on the left, and 22 data points for that element will display on the right. Each element's family and electron configuration will appear in gold below the Periodic Table. \r\n\r\n \r\n\r\nMove the cursor directly below the Periodic Table to browse all 10 element families. The elements in that family will be focused on the Periodic Table, and a description of that family will appear on the right. \r\n\r\n \r\n\r\nMove the cursor below the element families to browse all 4 electron configurations. The elements with that electron configuration will be focused on the Periodic Table, and a description of that electron shell will appear on the right. \r\n\r\n\r\n\r\n### Search\r\nUse letters or numbers to query for an element, family, or electron configuration. Queries are matched on element names, symbols, and atomic numbers, along with family names and electron configuration names. Just start typing to enter search mode. Press the Enter to select a search item, or the Left arrow to exit search mode.\r\n\r\n\r\n\r\n### Display Mode\r\nUse the SLASH (`/`) key to toggle different display modes. Use BACKSLASH (` \\ `) to toggle in reverse. The following 20 display modes are supported:\r\n\r\n#### Element Families\r\n\r\nDisplay 10 color-coded element families:\r\n\r\n\r\n\r\n#### Electron Configurations\r\n\r\nDisplay 4 color-coded electron shells:\r\n\r\n\r\n\r\n#### Standard State\r\n\r\nDisplay whether an element is a solid (white), liquid (red), or gas (blue). Expected states appear as a darker color (gray is expected solid, dark blue is expected gas):\r\n\r\n\r\n\r\n#### Atomic Mass\r\n\r\nDisplay a heat-map of atomic mass (increasing from blue to red):\r\n\r\n\r\n\r\n#### Protons\r\n\r\nDisplay a heat-map of the number of protons (increasing from blue to red):\r\n\r\n\r\n\r\n#### Neutrons\r\n\r\nDisplay a heat-map of the number of neutrons (increasing from blue to red):\r\n\r\n\r\n\r\n#### Electrons\r\n\r\nDisplay a heat-map of the number of electrons (increasing from blue to red):\r\n\r\n\r\n\r\n#### Valence Electrons\r\n\r\nDisplay a color-coded representation of the number of valence electrons:\r\n\r\n\r\n\r\n#### Valency\r\n\r\nDisplay a color-coded representation of valency:\r\n\r\n\r\n\r\n#### Atomic Radius\r\n\r\nDisplay a heat-map of atomic radius (increasing from blue to red):\r\n\r\n\r\n\r\n#### Density\r\n\r\nDisplay a heat-map of density (increasing from blue to red):\r\n\r\n\r\n\r\n#### Electronegativity\r\n\r\nDisplay a heat-map of electronegativity (increasing from blue to red):\r\n\r\n\r\n\r\n#### Ionization Energy\r\n\r\nDisplay a heat-map of ionization energy (increasing from blue to red):\r\n\r\n\r\n\r\n#### Electron Affinity\r\n\r\nDisplay a heat-map of electron affinity (increasing from blue to red):\r\n\r\n\r\n\r\n#### Melting Point\r\n\r\nDisplay a heat-map of melting point (increasing from blue to red):\r\n\r\n\r\n\r\n#### Boiling Point\r\n\r\nDisplay a heat-map of boiling point (increasing from blue to red):\r\n\r\n\r\n\r\n#### Specific Heat\r\n\r\nDisplay a heat-map of specific heat (increasing from blue to red):\r\n\r\n\r\n\r\n#### Radioactivity\r\n\r\nDisplay which elements are radioactive (red) and stable (green):\r\n\r\n\r\n\r\n#### Occurrence\r\n\r\nDisplay which elements have a natural occurrence (blue), rare occurrence (orange), or artificial occurrence (yellow):\r\n\r\n\r\n\r\n#### Year\r\n\r\nDisplay a heat-map of the year each element was discovered (increasing from blue to red). Ancient elements appear in white:\r\n\r\n\r\n\r\n## Options\r\n\r\n### Data Mode\r\nThe `--mode=data` param displays a brief list of all the elements, including atomic number, element symbol, and element name: \r\n```\r\n$ periodic-table-cli --mode=data\r\n```\r\n\r\n\r\n#### Verbose\r\nAdd the optional `--verbose` flag (or shorthand `-v`) to display a detailed list of all elements with up to 27 data columns (limited by screen size):\r\n```\r\n$ periodic-table-cli --mode=data --verbose\r\n```\r\n\r\n\r\n#### Specific Elements\r\nSpecify an element to view data for that element. Elements can be specified using the `--atomic-number=<number>`, `--symbol=<symbol>`, or `--name=<name>` params:\r\n```\r\n$ periodic-table-cli --mode=data --atomic-number=<number>\r\n$ periodic-table-cli --mode=data --symbol=<symbol>\r\n$ periodic-table-cli --mode=data --name=<name>\r\n```\r\n\r\n\r\n### Chart Mode\r\nThe `--mode=chart` param prints a non-interactive Periodic Table of Elements: \r\n```\r\n$ periodic-table-cli --mode=chart\r\n```\r\n\r\n\r\nMinimum terminal width: 113 characters\r\n\r\n#### Small\r\nAdd the optional `--small` flag (or shorthand `-s`) to print a smaller non-interactive version of the Periodic Table of Elements:\r\n```\r\n$ periodic-table-cli --mode=chart --small\r\n```\r\n\r\n\r\nMinimum terminal width: 76 characters\r\n\r\n#### Specific Elements\r\nSpecify an element to view that element on the Periodic Table of Element. Elements can be specified using the `--atomic-number=<number>`, `--symbol=<symbol>`, or `--name=<name>` params:\r\n```\r\n$ periodic-table-cli --mode=chart --atomic-number=<number>\r\n$ periodic-table-cli --mode=chart --symbol=<symbol>\r\n$ periodic-table-cli --mode=chart --name=<name>\r\n```\r\n\r\n\r\n### App Mode (default)\r\n\r\nThe `--mode=app` param runs the app in interactive mode (default). \r\n```\r\n$ periodic-table-cli --mode=app\r\n```\r\n\r\n#### Specific Elements\r\nSpecify an element to launch the app on that element. Elements can be specified using the `--atomic-number=<number>`, `--symbol=<symbol>`, or `--name=<name>` params:\r\n```\r\n$ periodic-table-cli --mode=app --atomic-number=<number>\r\n$ periodic-table-cli --mode=app --symbol=<symbol>\r\n$ periodic-table-cli --mode=app --name=<name>\r\n```\r\n\r\n### Scrolling\r\nThe minimum required terminal screen dimensions are 156 columns x 46 rows. When using a smaller screen, some components may be cut off. To fix this, either make the screen bigger or use scrolling to pan across the screen:\r\n\r\n- Use `COMMA` (`,`) to scroll up.\r\n- Use `PERIOD` (`.`) to scroll down.\r\n- Use `LEFT CARROT` (`<`) to scroll left.\r\n- Use `RIGHT CARROT` (`>`) to scroll right.\r\n\r\n## Data Sources\r\nData used in the app is stored in an easy to edit [data file](https://github.com/spirometaxas/periodic-table-cli-py/blob/main/periodic_table_cli/data.json). The data is mostly imported from [PubChem](https://pubchem.ncbi.nlm.nih.gov/periodic-table/). \r\n\r\nLast Updated February 2024\r\n\r\n## License\r\n- [MIT](https://github.com/spirometaxas/periodic-table-cli-py/blob/main/LICENSE) © [Spiro Metaxas](https://spirometaxas.com)\r\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 Spiro Metaxas Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "An interactive Periodic Table of Elements app for the console!",
"version": "2.1.1",
"project_urls": {
"Homepage": "https://spirometaxas.com/projects/periodic-table-cli/",
"Repository": "https://github.com/spirometaxas/periodic-table-cli-py"
},
"split_keywords": [
"periodic table",
"periodic table of elements",
"periodic",
"periodic-table-cli",
"chemistry",
"elements",
"atoms",
"atomic",
"cli",
"console",
"terminal",
"shell",
"unicode"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "59eeca760f6206b513999ee97b6e7a304676eeb260b74314203fa7052f5a32f9",
"md5": "eb7bd0263286f5d2027cc7a739718a90",
"sha256": "ff0b7b676f192627696e3bdbebd0279b19147077ca79dbcc0e77d1b242308ace"
},
"downloads": -1,
"filename": "periodic_table_cli-2.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "eb7bd0263286f5d2027cc7a739718a90",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 44145,
"upload_time": "2024-02-25T17:29:13",
"upload_time_iso_8601": "2024-02-25T17:29:13.747466Z",
"url": "https://files.pythonhosted.org/packages/59/ee/ca760f6206b513999ee97b6e7a304676eeb260b74314203fa7052f5a32f9/periodic_table_cli-2.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "dada9a2e8af1c993b06923e0bad3951ee5a8eabf61f90d56e35ce343043ea969",
"md5": "b61341dc5f6864c745628707f563e846",
"sha256": "e7e44e97ac30e92760bebd586a2893b823270396524358ffb1d68de2f8713d40"
},
"downloads": -1,
"filename": "periodic-table-cli-2.1.1.tar.gz",
"has_sig": false,
"md5_digest": "b61341dc5f6864c745628707f563e846",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 43412,
"upload_time": "2024-02-25T17:29:15",
"upload_time_iso_8601": "2024-02-25T17:29:15.651764Z",
"url": "https://files.pythonhosted.org/packages/da/da/9a2e8af1c993b06923e0bad3951ee5a8eabf61f90d56e35ce343043ea969/periodic-table-cli-2.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-25 17:29:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "spirometaxas",
"github_project": "periodic-table-cli-py",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "periodic-table-cli"
}
