This software allows the creation of indexes of open citations (e.g. COCI).
- Python 3.7+
- libzip, see INSTALL.md from official repository for additional information.
- Redis (* mandatory for redis data source), see Installing Redis for additional information.
To install the index software you must first meet all the requirements above.
- First of all let's compile the cpp source files for the OCI lookup management
$ make build- Then install the binaries and add them to the $PATH
$ sudo make install- As a last step the python package must be installed, at the same time all the python scripts will be added to the $PATH
$ pip install .- To ensure that the installation has been carried out correctly start the tests
$ python -m unittest discover -s ./index/python/test -p "test_*.py"Done, enjoy :)
By default when index is installed a configuration file is created in ~/.opencitations/index/, namely config.ini. For more information about the semantics of the settings see config.ini.
See Usage.
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
OpenCitations Index is released under the ISC License.