README.md 3.21 KB
Newer Older
Vuillaume's avatar
Vuillaume committed
1 2 3 4
<p align="left">
<img src="docs/images/eossr_logo.png" width="400px" >
</p>

5

Vuillaume's avatar
Vuillaume committed
6
# The ESCAPE OSSR library
7

8 9 10 11 12 13
The eOSSR Python library gathers all the developments made for the OSSR. In particular, it includes:
- an API to programmatically access the OSSR, retrieve records and publish content
- functions to map and crosswalk metadata between the CodeMeta schema adopted for the OSSR and Zenodo internal schema
- functions to help developers automatically contribute to the OSSR, in particular using their continuous integration (see also code snippets)


Vuillaume's avatar
Vuillaume committed
14
Code: [https://gitlab.in2p3.fr/escape2020/wp3/eossr](https://gitlab.in2p3.fr/escape2020/wp3/eossr)
15
Documentation: [https://escape2020.pages.in2p3.fr/wp3/eossr/](https://escape2020.pages.in2p3.fr/wp3/eossr/)
16 17


Vuillaume's avatar
Vuillaume committed
18

19
[![](https://gitlab.in2p3.fr/escape2020/wp3/eossr/badges/master/pipeline.svg)](
20
https://gitlab.in2p3.fr/escape2020/wp3/eossr/-/commits/master)
21
[![](https://gitlab.in2p3.fr/escape2020/wp3/eossr/badges/master/coverage.svg)](
22
https://gitlab.in2p3.fr/escape2020/wp3/eossr/-/commits/master)
23
[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/5712/badge)](https://bestpractices.coreinfrastructure.org/projects/5712)
24 25 26
[![](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
[![](https://zenodo.org/badge/DOI/10.5281/zenodo.5524912.svg)](https://doi.org/10.5281/zenodo.5524912)
[![](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/git/https%3A%2F%2Fgitlab.in2p3.fr%2Fescape2020%2Fwp3%2Feossr/HEAD)
27 28


vuillaut's avatar
vuillaut committed
29

Vuillaume's avatar
Vuillaume committed
30
## Former stable versions
31

32
- v0.6: [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.6475946.svg)](https://doi.org/10.5281/zenodo.6475946)
Vuillaume's avatar
Vuillaume committed
33
- v0.5: [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.6352039.svg)](https://doi.org/10.5281/zenodo.6352039)
Vuillaume's avatar
Vuillaume committed
34
- v0.4: [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.6326454.svg)](https://doi.org/10.5281/zenodo.6326454)
35 36
- v0.3.3: [![](https://zenodo.org/badge/DOI/10.5281/zenodo.5592584.svg)](https://doi.org/10.5281/zenodo.5592584)
- v0.2 : [![](https://zenodo.org/badge/DOI/10.5281/zenodo.5524913.svg)](https://doi.org/10.5281/zenodo.5524913)
37 38


vuillaut's avatar
vuillaut committed
39 40
## Install

Vuillaume's avatar
Vuillaume committed
41 42
Commands to be run in your terminal.

Vuillaume's avatar
Vuillaume committed
43
### For users
vuillaut's avatar
vuillaut committed
44
```
45
pip install eossr
Vuillaume's avatar
Vuillaume committed
46
```
47

Vuillaume's avatar
Vuillaume committed
48 49
You can also run it with docker:
```
50
docker run -it gitlab-registry.in2p3.fr/escape2020/wp3/eossr:latest
Vuillaume's avatar
Vuillaume committed
51 52
```

53 54
[Visit our registry](https://gitlab.in2p3.fr/escape2020/wp3/eossr/container_registry) to see the available docker containers.

Vuillaume's avatar
Vuillaume committed
55 56 57
Note that `latest` tag always point to the latest stable released container.


Vuillaume's avatar
Vuillaume committed
58 59 60 61
### For developers

```
git clone https://gitlab.in2p3.fr/escape2020/wp3/eossr.git
Vuillaume's avatar
Vuillaume committed
62
pip install -e "./eossr"
Vuillaume's avatar
Vuillaume committed
63
```
64

Vuillaume's avatar
Vuillaume committed
65
#### Running tests
66
To run tests locally, run:
Vuillaume's avatar
Vuillaume committed
67
```
Vuillaume's avatar
Vuillaume committed
68
pip install -e "./eossr[tests]"
Vuillaume's avatar
Vuillaume committed
69

70
pytest eossr
Vuillaume's avatar
Vuillaume committed
71 72
```

73 74
Some tests will be skiped if `SANDBOX_ZENODO_TOKEN` is not defined in your environment variables.
If you want to run these tests, you will need to create a [sandbox zenodo token](https://sandbox.zenodo.org/account/settings/applications/tokens/new/) and add it to your env:
Vuillaume's avatar
Vuillaume committed
75
```
76
export SANDBOX_ZENODO_TOKEN="your_sandbox_token"
Vuillaume's avatar
Vuillaume committed
77 78
```

Vuillaume's avatar
Vuillaume committed
79 80 81
## License

See [LICENSE](LICENSE)
Vuillaume's avatar
Vuillaume committed
82

83 84
## Cite

85 86
To cite this library, use the cite section in [the Zenodo page](https://zenodo.org/record/5592584#.YiALJRPMI-Q) (right
column, below the `Versions` section).