Metadata-Version: 2.4
Name: jinyanniu_backend_client
Version: 1.0.4
Summary: Bestarter API
Home-page: 
Author: OpenAPI Generator community
Author-email: OpenAPI Generator Community <team@openapitools.org>
Project-URL: Repository, https://github.com/GIT_USER_ID/GIT_REPO_ID
Keywords: OpenAPI,OpenAPI-Generator,Bestarter API
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: httpx>=0.28.1
Requires-Dist: pydantic>=2.11
Requires-Dist: typing-extensions>=4.7.1
Dynamic: author

# jinyanniu-backend-client
Bestarter API Documentation

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 
- Package version: 1.0.4
- Generator version: 7.21.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python 3.9+

## Installation & Usage
### pip install

If the python package is hosted on a repository, you can install directly using:

```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)

Then import the package:
```python
import jinyanniu_backend_client
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import jinyanniu_backend_client
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import jinyanniu_backend_client
from jinyanniu_backend_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = jinyanniu_backend_client.Configuration(
    host = "http://localhost"
)



# Enter a context with an instance of the API client
async with jinyanniu_backend_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jinyanniu_backend_client.DefaultApi(api_client)
    item_id = 56 # int | 

    try:
        # Delete Item
        api_response = await api_instance.delete_items_by_id(item_id)
        print("The response of DefaultApi->delete_items_by_id:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DefaultApi->delete_items_by_id: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *http://localhost*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DefaultApi* | [**delete_items_by_id**](docs/DefaultApi.md#delete_items_by_id) | **DELETE** /items/{item_id} | Delete Item
*DefaultApi* | [**get_items**](docs/DefaultApi.md#get_items) | **GET** /items | List Items
*DefaultApi* | [**get_items_by_id**](docs/DefaultApi.md#get_items_by_id) | **GET** /items/{item_id} | Get Item
*DefaultApi* | [**get_root**](docs/DefaultApi.md#get_root) | **GET** / | Index
*DefaultApi* | [**post_items**](docs/DefaultApi.md#post_items) | **POST** /items | Create Item
*DefaultApi* | [**put_items_by_id**](docs/DefaultApi.md#put_items_by_id) | **PUT** /items/{item_id} | Update Item
*EventsApi* | [**post_events_extract**](docs/EventsApi.md#post_events_extract) | **POST** /events/extract | Extract generic events from article text
*EventsApi* | [**post_events_extract_mentions**](docs/EventsApi.md#post_events_extract_mentions) | **POST** /events/extract-mentions | Extract event mentions from article text
*EventsApi* | [**post_events_extract_stock_range**](docs/EventsApi.md#post_events_extract_stock_range) | **POST** /events/extract-stock-range | Search stock news in a date range and extract generic events
*EventsApi* | [**post_events_resolve_a_shares**](docs/EventsApi.md#post_events_resolve_a_shares) | **POST** /events/resolve-a-shares | Resolve mentioned companies to A-share candidates
*StockSelectionApi* | [**post_stock_selection_score**](docs/StockSelectionApi.md#post_stock_selection_score) | **POST** /stock-selection/score | Score one stock with a stock selection method
*WritersApi* | [**post_writers_stock_reversal_report**](docs/WritersApi.md#post_writers_stock_reversal_report) | **POST** /writers/stock-reversal-report | Generate a single-stock reversal-stage research report


## Documentation For Models

 - [GenericEventTextExtractionRequest](docs/GenericEventTextExtractionRequest.md)
 - [HTTPValidationError](docs/HTTPValidationError.md)
 - [ItemCreate](docs/ItemCreate.md)
 - [ItemUpdate](docs/ItemUpdate.md)
 - [LocationInner](docs/LocationInner.md)
 - [StockNewsEventExtractionRequest](docs/StockNewsEventExtractionRequest.md)
 - [StockReversalReportRequest](docs/StockReversalReportRequest.md)
 - [StockSelectionScoreRequest](docs/StockSelectionScoreRequest.md)
 - [ValidationError](docs/ValidationError.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization

Endpoints do not require authorization.


## Author




