Metadata-Version: 2.1
Name: chemname
Version: 0.0.2
Summary: A tool to convert any text to chemical names, where possible.
Author-email: lancylot <lancylot2004@proton.me>
License: MIT License
        
        Copyright (c) [2022] [Hongming Liu]
        
        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.
Project-URL: Homepage, https://github.com/lancylot2004/Chemname
Project-URL: Bug Tracker, https://github.com/lancylot2004/Chemname/issues
Keywords: chemistry,name,chemical
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE

# Chemname

This package converts any eligible text to its equivalent using chemical element names.

## Usage

```
>>> from chemname import chem
```

Results are return as a list of lists, each containing a possible alternative. If there is one possiblity:

```
>>> chem.chemcame("Ash")
    [['As', 'H']]
```

The matching process is case insensitive.

```
>>> chem.chemcame("ash")
    [['As', 'H']]
```

If there are more possibilities:

```
>>> chem.chemname("Practice")
[['P', 'Ra', 'C', 'Ti', 'Ce'], ['Pr', 'Ac', 'Ti', 'Ce']]
```
