api.strategies

api.strategies

Functions

Name	Description
create_strategy	Create a new strategy object.
delete_strategy	Delete a strategy from the database.
get_strategies	Get all strategies from the database.
get_strategy	Get a strategy from the database by name.
save_strategy	Save a strategy object to the database.

api.strategies.create_strategy(attrs)

Create a new strategy object.

Name	Type	Description	Default
attrs	dict[str, Any]	The attributes of the strategy object to create. Should adhere to the StrategyModel schema.	required

Name	Type	Description
	IStrategy	The strategy object

Name	Type	Description
	ValueError	If the strategy with the given name does not exist. If attrs does not adhere to the StrategyModel schema.

api.strategies.delete_strategy(name)

Delete a strategy from the database.

Name	Type	Description	Default
name	str	The name of the strategy to delete.	required

Name	Type	Description
	ValueError	If the strategy does not exist.

api.strategies.get_strategies()

Get all strategies from the database.

Name	Type	Description
	dict[str, Any]	A dictionary containing all strategies. Includes keys: ‘name’, ‘description’, ‘path’, ‘last_modification_date’, ‘objects’ Each value is a list of the corresponding attribute for each strategy.

api.strategies.get_strategy(name)

Get a strategy from the database by name.

Name	Type	Description	Default
name	str	The name of the strategy to retrieve.	required

Name	Type	Description
	IStrategy	The strategy object with the given name.

Name	Type	Description
	ValueError	If the strategy with the given name does not exist.

api.strategies.save_strategy(strategy)

Save a strategy object to the database.

Name	Type	Description	Default
strategy	IStrategy	The strategy object to save.	required

Name	Type	Description
	ValueError	If the strategy object is not valid. If the strategy object already exists.