Merge pull request #5 from julia-sprenger/enh/install

Improve install, update and authentication handling

.gitignore

@@ -160,6 +160,9 @@ venv.bak/
 *.log
 *.pptx
 
+# IDEs
+.vscode
+
 # This repository
 geo/
 invenio.py

README.md

@@ -1,4 +1,4 @@
-[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/shinokumura/exfor_dictionary/main?labpath=example/example.ipynb)
+[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/IAEA-NDS/exfor_dictionary/main?labpath=example/example.ipynb)
 
 ## Introduction to the EXFOR dictionary in JSON
 You may find many mysterious keywords in EXFOR entries such as:
@@ -99,9 +99,14 @@ The EXFOR dictionary is updated irregular basis, so if you need to run the updat
 python convert_dictionary.py
 ```
 
-Parsing all information is not yet perfect. Currently, JSON files are produced for some of ```DICTION``` with information that are used in the EXFOR parser. 
+Note, that currently the IAEA-NDS "Open" Area is password protected. To run the update successfully you will need to provide your credentials as environment variables:
 
+```bash
+export OPENAREA_USER=<my_user_name>
+export OPENAREA_PWD=<my_user_password>
+```
 
+Parsing all information is not yet perfect. Currently, JSON files are produced for some of ```DICTION``` with information that are used in the EXFOR parser. 
 
 ## Contact
 [email protected]

pyproject.toml

@@ -8,7 +8,6 @@ name = "exfor_dictionary"
 authors = [
     {name = "Shin Okumura/IAEA-NDS", email = "[email protected]"},
 ]
-version = "1.0.0b"
 description = "JSON converter for the EXFOR dictionary"
 readme = "README.md"
 requires-python = ">=3.8"
@@ -20,11 +19,12 @@ classifiers = [
     "License :: OSI Approved :: MIT License",
     "Programming Language :: Python :: 3",
 ]
-dynamic = ["dependencies"]
+dynamic = ["dependencies", "version"]
 
 
 [tool.setuptools.dynamic]
 dependencies = {file = ["requirements.txt"]}
+version = {file = "VERSION"}
 
 
 [tool.setuptools.packages.find]
@@ -40,5 +40,5 @@ include-package-data = true
 "exfor_dictionary.pickles" = ["*.pickle"]
 
 [project.urls]
-Homepage = "https://github.com/shinokumura/ripl3_json"
+Homepage = "https://github.com/IAEA-NDS/exfor_dictionary"
 

requirements.txt

@@ -1,15 +1,15 @@
-beautifulsoup4==4.12.2
-certifi==2023.7.22
-chardet==5.2.0
-charset-normalizer==3.2.0
-idna==3.4
-numpy==1.25.2
-pandas==2.0.3
-python-dateutil==2.8.2
-pytz==2023.3
-requests==2.31.0
-six==1.16.0
-soupsieve==2.4.1
-tzdata==2023.3
-# urllib3==2.0.4
-urllib3==1.26.6
+beautifulsoup4>=4.12.2
+certifi>=2023.7.22
+chardet>=5.2.0
+charset-normalizer>=3.2.0
+idna>=3.4
+numpy>=1.25.2
+pandas>=2.0.3
+python-dateutil>=2.8.2
+pytz>=2023.3
+requests>=2.31.0
+six>=1.16.0
+soupsieve>=2.4.1
+tzdata>=2023.3
+# urllib3>=2.0.4
+urllib3>=1.26.6