pyvec / pyvec/naucse

Finalize the API

Open
#16 8 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

API
Dominant language
Python
Stars
2
Forks
11
PR merge metrics
No merged PRs in 30d

Description

The API is currently at version 0 ("beta"). It should get some real-world testing before it's finalized.
Documentation is scarce; consult the JSON schema if the meaning of some field is not clear.
If you use the API, please report individual issues or discuss on Slack if something is not right.

If you use the API, please subscribe to this issue to get change notifications.
From version 1 there will be a backwards compatibility promise.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by exercising the v0 API at naucse.python.cz/v0/naucse.json and compare its responses with the linked course JSON schema. Gather concrete issues from real-world use and review them with the maintainers; done means the API has been tested, its remaining problems are resolved or documented, and the version-1 compatibility promise is ready.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.