delvtech / agent0

Analysis & simulation repo for Delv
https://agent0.readthedocs.io/en/latest/
Apache License 2.0
52 stars 21 forks source link

rename monorepo & set up docs #963

Closed dpaiton closed 12 months ago

dpaiton commented 1 year ago

We need to solidify a brand & naming convention for our open-source products.

Our brand will be "Agent 0". Our monorepo will be delvtech/agent0. This will house projects that are still under heavy development and are not ready to be advertised broadly. Projects that _are_ready to be advertised broadly will go into their own repos under the delvtech organization. This currently includes fixedpointmath and pypechain, but will eventually include other offerings (notably the hyperdrive sdk).

TODOs:

dpaiton commented 1 year ago

Here's the pending landscape, as I see it:

Note that the HyperdriveInterface API is not the same as the python-wrapped hyperdrive-sdk. The former (HyperdriveInterface) is a high-level end-point for people developing bots and experiment (for example, Jupyter notebook) pipelines. This is analogous to the typescript API. The later (hyperdrive-sdk) is a suite of high-performance, low-level Hyperdrive and Yieldspace math functions implemented in rust and wrapped in python. The HyperdriveInterface API uses a lot of the utility functions provided by the hyperdrive-sdk python package.

dpaiton commented 1 year ago

I created an issue on pypi #3251 to claim the botkit package name.

dpaiton commented 12 months ago

We are going to hold off on setting up the docs pages until we can integrate it with hyperdrive. The rest of the tasks are done or no longer planned.