Welcome to eOSSR’s documentation!

• The ESCAPE OSSR library
  • Former stable versions
  • Install
    • For users
    • For developers
      • Running tests
  • Online CodeMeta validator for the OSSR
  • License
  • Cite
• eOSSR API Documentation
  • eossr.api package
    • eossr.api.zenodo package
      • eossr.api.zenodo.http_status module
      • eossr.api.zenodo.zenodo module
    • eossr.api.ossr module
      • get_ossr_pending_requests()
      • get_ossr_records()
  • eossr.metadata package
    • Subpackages
      • eossr.metadata.schema package
    • Submodules
    • eossr.metadata.codemeta module
      • Codemeta
      • codemeta_crosswalk()
      • schema()
    • eossr.metadata.codemeta2zenodo module
      • CodeMeta2ZenodoController
      • add_author_metadata()
      • converter()
      • find_matching_metadata()
      • parse_codemeta_and_write_zenodo_metadata_file()
      • parse_person_schema_property()
    • eossr.metadata.zenodo module
      • add_escape2020_community()
      • add_escape2020_grant()
      • schema()
      • validate_zenodo_metadata()
    • Module contents
  • eossr.utils module
    • ZipUrl
      • ZipUrl.find_files()
      • ZipUrl.get_codemeta()
    • get_codemeta_from_zipurl()
    • zip_repository()
  • eOSSR CLI programs
    • eossr-codemeta2zenodo
    • eossr-upload-repository
    • eossr-metadata-validator
    • eossr-zip-repository
    • eossr-check-connection-zenodo
• OSSR metadata
  • OSSR metadata introduction
    • Quickstart - How to incorporate a CodeMeta metadata file into your project.
      • Keywords list
    • Create a Zenodo metadata file from the a CodeMeta schema file
      • Extending the CodeMeta Context schema
  • OSSR metadata table
  • Add funding to metadata
    • Find your funding
      • Zenodo services
    • Add funding to codemeta.json
  • Example of protocols to harvest metadata from Zenodo
    • Pros and cons of each method
    • OAI-PMH protocol
      • First have a look at a nice tutorial on the protocol.
    • Zenodo’s REST API
      • A specific ESCAPE2020 entry: agnpy.
    • eossr
• OSSR Statistics
• Examples
  • How to use ZipUrl
    • How it is used in eossr
  • Find ESCAPE OSSR records
    • Getting all the records
    • Specific search
      • Using strings
      • Using keywords
      • Directly from its id
    • Record methods
    • Getting CodeMeta metadata
    • MyBinder integration
  • Upload records on the OSSR
    • Create a new entry
      • Zenodo HTTP status
    • Add files to the entry
    • Add metadata to the entry
      • Check the content of the new entry
    • Publish the entry
• GitLab to Zenodo
  • Upload from GitLab in 4 steps
    • 1. Include an ESCAPE CodeMeta metadata file
    • 2. Link your GitLab project with Zenodo.
    • 3. Into your .gitlab-ci.yml file
    • 4. ‘One-click-build-and-publish’
  • What happens during the GitLab-Zenodo CI process
    • Trigger the GitLabCI and publish your project to Zenodo.
• Snippets
  • Build a Docker container during the CI process
  • Build a Singularity image during the CI process
  • Upload to the OSSR
    • Important note
      • Upload to Zenodo
      • Upload to Sandbox Zenodo
  • Test your metadata validity on the main (master) branch
    • GitLab
      • Test your codemeta.json file
      • Test your .zenodo.json file
    • GitHub
      • Test your .zenodo.json file
• Useful resources
  • Schema.org & CodeMeta tools
    • CodeMeta generators and converters
    • The metadata jungle
  • Zenodo

Indices and tables

• Index

• Module Index

• Search Page