https://github.com/opencitations/api

Software for creating REST API
https://github.com/opencitations/api

Last synced: 4 months ago
JSON representation

Software for creating REST API

• Host: GitHub
• URL: https://github.com/opencitations/api
• Owner: opencitations
• Created: 2018-04-08T15:04:05.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2025-07-01T19:49:05.000Z (11 months ago)
• Last Synced: 2025-07-01T20:23:11.774Z (11 months ago)
• Language: Python
• Size: 54.8 MB
• Stars: 1
• Watchers: 7
• Forks: 1
• Open Issues: 9
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
[](http://opencitations.net)

[![Run tests](https://github.com/opencitations/api/actions/workflows/run_tests.yml/badge.svg?branch=master)](https://github.com/opencitations/api/actions/workflows/run_tests.yml)

[![Coverage](https://byob.yarr.is/arcangelo7/badges/opencitations-api-coverage-master)](https://opencitations.github.io/api/)

# api

REST API specification for all the OpenCitations datasets

## Installation

Install dependencies using [uv](https://docs.astral.sh/uv/):

```bash

uv sync

```

## Testing

### Prerequisites

- Docker (for test database)

### Running Tests

1. Install development dependencies:

   ```bash

   uv sync --dev

   ```

2. Start the test database:

   ```bash

   ./test/start_test_db.sh  # Linux/macOS

   # or

   .\test\start_test_db.ps1  # Windows PowerShell

   ```

3. Run the test suite:

   ```bash

   uv run pytest

   ```

4. Stop the test database:

   ```bash

   ./test/stop_test_db.sh  # Linux/macOS

   # or

   .\test\stop_test_db.ps1  # Windows PowerShell

   ```