Point72 / Point72/csp

Expand adapters concepts

Open
#292 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

part: documentation
Dominant language
Python
Stars
441
Forks
90
Avg merge
1d 12m
Merged PRs (30d)
5

Description

Conceptually, explain the following in https://github.com/Point72/csp/wiki/Adapters:

  • Push and Pull Input Adapters
  • AdapterManagers
  • Writing an adapter in Python
  • Push mode

We can add links to the how-to write adapter pages from here.

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 with the Adapters wiki page linked in the issue and review the existing adapter how-to pages. Expand the page to explain Push and Pull Input Adapters, AdapterManagers, writing an adapter in Python, and Push mode, adding links to the how-to pages; done means all four checklist items are covered.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
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.