Merge pull request #16 from DunklesArchipel/typoes

Remove typos and adapt readme

.gitignore

@@ -135,3 +135,6 @@ dmypy.json
 
 # VS Code
 .vscode/
+
+# rever
+rever/

README.md

@@ -12,14 +12,31 @@ described [here](https://echemdb.github.io/svgdigitizer/workflow.html).
 
 ## Accessing Data
 
+***Direct download***
+
 The resulting data can be downloaded as a ZIP from the release section.
 
 Alternatively you can use the [`unitpackages`](https://echemdb.github.io/unitpackage/) interface
 (see [`unitpackages` installation instructions](https://echemdb.github.io/unitpackage/installaton.html)).
 
-## Create Data Locally
+***From the API***
+
+Install the latest version of the module.
+
+```sh
+pip install [email protected]:echemdb/electrochemistry-data.git
+```
+
+In your preferred Python environment retrieve the URL via
+
+```py
+from echemdb_ecdata.url import ECHEMDB_DATABASE_URL
+ECHEMDB_DATABASE_URL
+```
 
-To create the output data packages locally clone the repository
+## Development
+
+Clone the repository
 
 ```sh
 git clone [email protected]:echemdb/electrochemistry-data.git
@@ -33,7 +50,9 @@ conda create -f environment.yaml
 conda activate echemdb-data
 ```
 
-Run the makefile in the `data` folder.
+***Create data locally***
+
+Run the makefile in the `data` folder to create data locally.
 
 ```sh
 cd data

echemdb_ecdata/url.py

@@ -2,27 +2,27 @@
 URL to a ZIP containing the latest echemdb electrochemistry data.
 """
 # ********************************************************************
-#  This file is part of unitpackage.
+#  This file is part of electrochemistry-data.
 #
-#        Copyright (C) 2021-2024 Albert Engstfeld
+#        Copyright (C) 2024 Albert Engstfeld
 #
-#  unitpackage is free software: you can redistribute it and/or modify
+#  electrochemistry-data is free software: you can redistribute it and/or modify
 #  it under the terms of the GNU General Public License as published by
 #  the Free Software Foundation, either version 3 of the License, or
 #  (at your option) any later version.
 #
-#  unitpackage is distributed in the hope that it will be useful,
+#  electrochemistry-data is distributed in the hope that it will be useful,
 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 #  GNU General Public License for more details.
 #
 #  You should have received a copy of the GNU General Public License
-#  along with unitpackage. If not, see <https://www.gnu.org/licenses/>.
+#  along with electrochemistry-data. If not, see <https://www.gnu.org/licenses/>.
 # ********************************************************************
 
 import os
 
 ECHEMDB_DATABASE_URL = os.environ.get(
     "ECHEMDB_DATABASE_URL",
-    "https://github.com/echemdb/electrochemistry-data/releases/download/0.2.1/data-0.2.1.zip",
+    "https://github.com/echemdb/electrochemistry-data/releases/download/0.2.0/data-0.2.0.zip",
 )

setup.py

@@ -1,28 +1,28 @@
 # ********************************************************************
 #  This file is part of electrochemistry-data.
 #
-#        Copyright (C)      2024 Albert Engstfeld
+#        Copyright (C) 2024 Albert Engstfeld
 #
-#  echemdb is free software: you can redistribute it and/or modify
+#  electrochemistry-data is free software: you can redistribute it and/or modify
 #  it under the terms of the GNU General Public License as published by
 #  the Free Software Foundation, either version 3 of the License, or
 #  (at your option) any later version.
 #
-#  echemdb is distributed in the hope that it will be useful,
+#  electrochemistry-data is distributed in the hope that it will be useful,
 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 #  GNU General Public License for more details.
 #
 #  You should have received a copy of the GNU General Public License
-#  along with echemdb. If not, see <https://www.gnu.org/licenses/>.
+#  along with electrochemistry-data. If not, see <https://www.gnu.org/licenses/>.
 # ********************************************************************
 
 from distutils.core import setup
 
 setup(
     name='electrochemistry_data',
     version="0.2.1",
-    packages=['echemdb_ecdata'],
+    packages=['electrochemistry-data_ecdata'],
     license='GPL 3.0+',
     long_description=open('README.md').read(),
     include_package_data=True,