https://github.com/arxiv/zzzarchived_arxiv-api-gateway

https://github.com/arxiv/zzzarchived_arxiv-api-gateway

arxiv-ng flask python

Last synced: about 4 hours ago
JSON representation

• Host: GitHub
• URL: https://github.com/arxiv/zzzarchived_arxiv-api-gateway
• Owner: arXiv
• License: mit
• Archived: true
• Created: 2018-11-02T14:37:05.000Z (about 6 years ago)
• Default Branch: develop
• Last Pushed: 2023-02-15T20:15:56.000Z (over 1 year ago)
• Last Synced: 2024-11-06T17:12:54.873Z (about 4 hours ago)
• Topics: arxiv-ng, flask, python
• Language: HTML
• Homepage:
• Size: 48.8 KB
• Stars: 3
• Watchers: 15
• Forks: 4
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# arXiv API Gateway

This project pulls together documentation (including specifications) for the

arXiv API Gateway. The intended audience is arXiv API users, including partner

platforms.

Documentation for individual services is maintained in the respective

repositories for those services. This project largely involves pulling down

those docs into a single resource, which is then published as (almost) static

pages.

## Running for development

1. Install dependencies

```bash

pipenv install

```

2. Build the site index

```bash

pipenv run python build.py

```

3. Run the Flask development server

```bash

LOGLEVEL=10 FLASK_APP=app.py pipenv run flask run

```

You should find the root page at http://127.0.0.1:5000

## TODO:

- [ ] Automate pulling down the latest version of each API's schema

- [ ] Polish styling; make CSS in templates not hard-coded (shame shame).

- [ ] Maybe it would be better to implement the OpenAPI rendering bit as a

  Python-markdown plugin?