pyfar / pyfar/sofar

Add possibility to add and a remove a local convnetion for testing

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

Nobody has claimed this yet.

feature
Dominant language
Python
Stars
34
Forks
4
Avg merge
11m
Merged PRs (30d)
2

Description

Functions add_convention and remove_convention would be nice to have to locally test new conventions.

add_convention would get a path to a csv of json file to be copied to the conventions folder and than call sofar.update_conventions._compile_conventions. remove_convention gets a convention name as str and removes it from the conventions folder.

Contributor guide

Open the contributing guide

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 locating the existing conventions folder and the sofar.update_conventions._compile_conventions entry point. Add the two requested functions around that workflow: one should copy a CSV or JSON convention file and compile it, while the other should remove a convention by name. Done means both local operations work as described and leave the conventions folder and compiled conventions consistent.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
testing
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.