Skip to content

Commit

Permalink
Update readme (#64)
Browse files Browse the repository at this point in the history
* chore: update readme

* fix: http -> https
  • Loading branch information
martinkersner authored Oct 20, 2024
1 parent 6ebf290 commit ddb484d
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# DataMaxi+ Python Client
# DataMaxi+ Python SDK

[![PyPI version](https://img.shields.io/pypi/v/datamaxi)](https://pypi.python.org/pypi/datamaxi)
[![Python version](https://img.shields.io/pypi/pyversions/datamaxi)](https://www.python.org/downloads/)
[![Documentation](https://img.shields.io/badge/docs-latest-blue)](https://datamaxi.readthedocs.io/en/stable/)
[![Code Style](https://img.shields.io/badge/code_style-black-black)](https://black.readthedocs.io/en/stable/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

This is the official implementation of Python client for DataMaxi+ API.
This is the official implementation of Python SDK for DataMaxi+ API.
The package can be used to fetch both historical and latest data using [DataMaxi+ API](https://docs.datamaxiplus.com/).
This package is compatible with Python v3.8+.

Expand All @@ -29,21 +29,21 @@ pip3 install datamaxi

## Configuration

Access to DataMaxi+ is protected by API Key.
If you are interested to try DataMaxi+, you can simply sign up for DataMaxi+ through [this login/singup page](https://datamaxiplus.com/auth) and get free API key for two months.
Private API endpoints are protected by an API key.
You can get the API key upon registering at https://datamaxiplus.com/auth.

| Option | Explanation |
| ------------------ | ------------------------------------------------------------------------------------- |
|--------------------|---------------------------------------------------------------------------------------|
| `api_key` | Your API key |
| `base_url` | If `base_url` is not provided, it defaults to `api.datamaxiplus.com`. |
| `base_url` | If `base_url` is not provided, it defaults to `https://api.datamaxiplus.com`. |
| `timeout` | Number of seconds to wait for a server response. By default requests do not time out. |
| `proxies` | Proxy through which the request is queried |
| `show_limit_usage` | Return response as dictionary including `"limit_usage"` and `"data"` keys |
| `show_header` | Return response as dictionary including `"header"` and `"data"` keys |

### Environment Variables

You may use environment variables to configure the DataMaxi+ client to avoid any inline boilerplate.
You may use environment variables to configure the SDK to avoid any inline boilerplate.

| Env | Description |
| ------------------ | -------------------------------------------- |
Expand Down Expand Up @@ -104,8 +104,8 @@ python3 -m pytest tests/

## Links

- [DataMaxi+](https://datamaxiplus.com/)
- [DataMaxi+ API Documentation](https://docs.datamaxiplus.com/)
- [Official Website](https://datamaxiplus.com/)
- [Documentation](https://docs.datamaxiplus.com/)

## Contributing

Expand Down
2 changes: 1 addition & 1 deletion datamaxi/lib/constants.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
BASE_URL = "http://api.datamaxiplus.com"
BASE_URL = "https://api.datamaxiplus.com"

0 comments on commit ddb484d

Please sign in to comment.