| Name | KrakenPythonMarcosRodrigo JSON |
| Version |
0.1.2
JSON |
| download |
| home_page | |
| Summary | A streamlit tool for rendering kraken data |
| upload_time | 2023-12-29 16:16:35 |
| maintainer | |
| docs_url | None |
| author | Your Name |
| requires_python | >=3.11,<4.0 |
| license | |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# KrakenPythonMarcosRodrigo
This project serves as an analytical tool designed for examining currency pairs on the Kraken cryptocurrency exchange platform. The application retrieves up-to-date pricing information for a range of currency pairs through the Kraken API, presenting this data in a clear and interactive format.
Furthermore, it computes key technical analysis indicators, including the stochastic oscillator and its moving average. These features are designed to support and enhance trading decision-making.
This project is developed in Python and leverages a variety of libraries to enhance its functionality.
It utilizes pandas for data manipulation, plotly for dynamic data visualization, krakenex for seamless interaction with the Kraken API, and streamlit to provide the web application capabilities.
## Project Structure
The main file of our project is `main.py`. It uses functions and classes from other files. For example, `graphs.py` has the `class Graph`, which we use to make candlestick charts and stochastic oscillators. Another important file is `front.py`, which has the `class Front` for the user interface part of our app.
The project also has a `pyproject.toml` file that names all the Python packages required to run the project. The project can be executed in a Docker container. using the provided Dockerfile.
The project also includes a `tests.py` file for testing different parts of the project, using unit-testing and integration-testing. The tests cover (amongst other functionalities) the initialization of the Front and Graph classes, the retrieval of currency pairs from the Kraken API, and the creation of graphs.
## How to Run the Project
To run the project, you need to have Python installed on your machine.
You can then install the required packages using poetry:
`poetry install`
After installing the required packages, you can run the project using the following command:
`streamlit run main.py`
This will start the Streamlit app and open it in your web browser.
## Documentation
The docs folder contains several files providing more details about the project and its requirements.
## Authors
This project was created by Rodrigo de la Nuez Moraleda and Marcos Castro Cacho.
Raw data
{
"_id": null,
"home_page": "",
"name": "KrakenPythonMarcosRodrigo",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Your Name",
"author_email": "you@example.com",
"download_url": "https://files.pythonhosted.org/packages/8f/a5/e1005d15729a865514ffe427c6f2d17f7da57f9b3e37fc5b78d96403ed23/krakenpythonmarcosrodrigo-0.1.2.tar.gz",
"platform": null,
"description": "# KrakenPythonMarcosRodrigo\n\nThis project serves as an analytical tool designed for examining currency pairs on the Kraken cryptocurrency exchange platform. The application retrieves up-to-date pricing information for a range of currency pairs through the Kraken API, presenting this data in a clear and interactive format. \n\nFurthermore, it computes key technical analysis indicators, including the stochastic oscillator and its moving average. These features are designed to support and enhance trading decision-making.\n\nThis project is developed in Python and leverages a variety of libraries to enhance its functionality. \n\nIt utilizes pandas for data manipulation, plotly for dynamic data visualization, krakenex for seamless interaction with the Kraken API, and streamlit to provide the web application capabilities.\n\n## Project Structure\n\nThe main file of our project is `main.py`. It uses functions and classes from other files. For example, `graphs.py` has the `class Graph`, which we use to make candlestick charts and stochastic oscillators. Another important file is `front.py`, which has the `class Front` for the user interface part of our app.\n\nThe project also has a `pyproject.toml` file that names all the Python packages required to run the project. The project can be executed in a Docker container. using the provided Dockerfile.\n\nThe project also includes a `tests.py` file for testing different parts of the project, using unit-testing and integration-testing. The tests cover (amongst other functionalities) the initialization of the Front and Graph classes, the retrieval of currency pairs from the Kraken API, and the creation of graphs.\n\n\n## How to Run the Project\n\nTo run the project, you need to have Python installed on your machine. \n\nYou can then install the required packages using poetry:\n\n`poetry install`\n\nAfter installing the required packages, you can run the project using the following command:\n\n`streamlit run main.py`\n\nThis will start the Streamlit app and open it in your web browser.\n\n## Documentation\n\nThe docs folder contains several files providing more details about the project and its requirements.\n\n## Authors\n\nThis project was created by Rodrigo de la Nuez Moraleda and Marcos Castro Cacho.\n\n",
"bugtrack_url": null,
"license": "",
"summary": "A streamlit tool for rendering kraken data",
"version": "0.1.2",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4a085e51aafccf4ccc7bf065347437f4680d69fca617d4a8cc4bf13eeeeff293",
"md5": "85bde7daeb011cafec74fbcb5826dbe5",
"sha256": "b2331cdb5047ce88ac9bdb7f3b236e7c4ea14428acc7d75fbb1a192a7f3faa20"
},
"downloads": -1,
"filename": "krakenpythonmarcosrodrigo-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "85bde7daeb011cafec74fbcb5826dbe5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11,<4.0",
"size": 2313,
"upload_time": "2023-12-29T16:16:34",
"upload_time_iso_8601": "2023-12-29T16:16:34.614370Z",
"url": "https://files.pythonhosted.org/packages/4a/08/5e51aafccf4ccc7bf065347437f4680d69fca617d4a8cc4bf13eeeeff293/krakenpythonmarcosrodrigo-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8fa5e1005d15729a865514ffe427c6f2d17f7da57f9b3e37fc5b78d96403ed23",
"md5": "4a3eb92c966a1715f9c076970a2fe95b",
"sha256": "b442ded61dd73964aa0ece094a4ddb43aa6567cd112f23edd0d37859bd355322"
},
"downloads": -1,
"filename": "krakenpythonmarcosrodrigo-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "4a3eb92c966a1715f9c076970a2fe95b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11,<4.0",
"size": 2019,
"upload_time": "2023-12-29T16:16:35",
"upload_time_iso_8601": "2023-12-29T16:16:35.584440Z",
"url": "https://files.pythonhosted.org/packages/8f/a5/e1005d15729a865514ffe427c6f2d17f7da57f9b3e37fc5b78d96403ed23/krakenpythonmarcosrodrigo-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-29 16:16:35",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "krakenpythonmarcosrodrigo"
}
