Metadata-Version: 2.1
Name: crypto-screening
Version: 4.0.0
Summary: A software for automatically recording real-time crypto exchanges and pairs OHLCV and Orderbook rates.
Home-page: https://github.com/Shahaf-F-S/crypto-screening
Author: Shahaf Frank-Shapir
Author-email: shahaffrs@gmail.com
License: MIT
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Provides-Extra: dev

# crypto-screening

> A software for automatically recording real-time crypto exchanges and pairs OHLCV and Orderbook rates.

first of all
------------

#### specifics:

- written and owned by: Shahaf Frank-Shapir
- all the rights are saved for Shahaf Frank-Shapir
- programming languages: python 3.9.12 (100%)

before we start
---------------

#### description:

- visit the docs to learn more about this project and how to develop using it.

#### dependencies:

- opening:
  As this is a really complex program, which uses a lot of modules, there are required dependencies needed
  in order to run the program. keep in mind the program was written in Python 3.9, so any Python version lower
  than 3.8 might not work properly. Moreover, built-in Python modules are being used, so keep that in mind.

- install app dependencies by writing the "-r" option to install the requirements
  written in a file, and write the following line in the project directory:
````
pip install -r requirements.txt
````

run a test
-----------

#### run from the Windows command line (inside the project directory)
- run with Python by writing to the command line in the project directory:
````
python test.py
````
