Take decision on whether / how the nexus-python-sdk checks Nexus API specific constraints

Open
#50 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Start by reviewing the nexussdk.organizations.create entry point and the nexus-python-sdk docstrings, then compare the questions against the Nexus V1 API constraints. Done means the project has recorded a decision on whether to validate or document org_label restrictions and whether to define vocab and base.

Written by the indexing model from the issue text.

Description

This is feedback provided after a first usage of the nexus-python-sdk and its documentation to perform basic operations in a Nexus V1 deployment.

Regarding propagating specifics from the Nexus API, the following questions were noted:

  • Should constraints given by the Nexus API be checked / explicitely stated in the nexus-python-sdk, e.g. should the parameter org_label in nexussdk.organizations.create be checked to not contain upper case letters or spaces?
  • Should terms like vocab and base be further described in the docstrings of the nexus-python-sdk?
Dominant language
Python
Stars
6
Forks
10
No merged PRs in 30d

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.

More from BlueBrain/nexus-python-sdk

All issues in BlueBrain/nexus-python-sdk

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.