Metadata-Version: 2.1
Name: cira-classic
Version: 1.0.2
Summary: A older style of the cira library.
Home-page: https://github.com/AxelGard/cira-classic/
Author: Axel Gard
Author-email: axel.gard@tutanota.com
License: MIT
Description: # cira-classic
        A simpler library for alpaca-trade-api from Alpaca Markets.
        Cira is available on [pip](https://pypi.org/project/cira/). **Plz give it a star if you like it!**
        
        ![a cira](https://external-content.duckduckgo.com/iu/?u=https%3A%2F%2Fi.pinimg.com%2F236x%2F5c%2F96%2Ff4%2F5c96f496d05b7826f7d0714b7bd282ad--love-drawings-draw-animals.jpg&f=1&nofb=1)
        
        ![GitHub stars](https://img.shields.io/github/stars/AxelGard/cira-classic?style=social)
        [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/Axel_Gard)
        
        ![GitHub](https://img.shields.io/github/license/AxelGard/cira-classic?style=plastic)
        ![PyPI](https://img.shields.io/pypi/v/cira-classic)
        ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/cira-classic)
        
        I was interested in using the Alpaca trade API for building a quantitative paper trader.
        The project is available [here](https://github.com/AxelGard/paper-trader).<br>
        However after working on this for alomst a year (off and on) I realized that I had alomst build a small library for using the Alpaca API.
        So I thought that I would make this into a real library so that you can get started with quantitative paper trading as well.
        
        The name [cira](https://en.wikipedia.org/wiki/cira-classic) is the word for a baby alpaca and because this is a simple and small lib I thought it would be a perfect fit.
        
        
        ## Getting Started
        
        ### Installation
        You can install it using [pip](https://pypi.org/project/cira-classic/).
        ```bash
        pip install cira-classic
        ```
        
        ### Usage
        Since the Alpaca trade API need a key, you need to generate your own and keep it in a **JSON file** which cira needs the **path** to.
        You can also set the variables directly or use an environment variable. However, it is recommended that you store it in a file.<br>
        **key.json**
        ```json
        {
          "APCA-API-KEY-ID":"your_pub_key",
          "APCA-API-SECRET-KEY":"your_private_key"
        }
        ```
        then you can start using the lib
        ```python
        import cira-classic as cira
        cira.KEY_FILE = "../mypath/key.json"
        cira.buy(1, "TSLA")
        print(cira.get_postion())
        cira.sell(1, "TSLA")
        ```
        
        ## [Wiki](https://github.com/AxelGard/cira/wiki) and docs
        
        To see what more you can do check out the [wiki](https://github.com/AxelGard/cira-classic/wiki).
        
        I also have an example of how to build a [index fund trader with cira](https://axelgard.github.io/blog/cira/2020/08/20/cira-index-fund.html) or check out [paper-trader](https://github.com/AxelGard/paper-trader) for my usage of cira.
        
        ## Versioning & News
        
        cira still has some things that need be implemented in order to be enter a v0.1.0, for exampel stock shorting and support for more stock markets than NASDAQ.
        
        if you find bug plz let me know with a issue. If you know how to solve the problem then you can of course make a pull request and I will take a look at it.
        
        ## Development
        To install cira with all the dev req.
        ```bash
        git clone git@github.com:AxelGard/cira-classic.git
        cd cira-classic/
        git checkout develop
        ```
        and know you need to  
        ```bash
        python3 -m venv env
        source env/bin/activate
        pip install -e .[dev]
        ```
        Run tests using pytest. Ensure that you are in the cira dir.
        But you will need a new key. This key should not only be used for testing or if you don't mind if all of the assets in the portfolio being sold.   
        ```bash
        touch tests/test_key.json
        pytest
        ```
        
        
        ### Coding style
        I have been building this in a very [functional programming style](https://en.wikipedia.org/wiki/Functional_programming). I'm also trying to follow the [pep8](https://pep8.org/) standard notation.
        
        ## License
        This project is licensed under the MIT License - see the [LICENSE](LICENSE.txt) file for details
        
        
        ## Acknowledgments
        
        * [Alpaca API](https://alpaca.markets/)
        * [cira](https://github.com/AxelGard/cira-classic)
        * [paper-trader](https://github.com/AxelGard/paper-trader)
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Topic :: Office/Business :: Financial
Classifier: Programming Language :: Python :: 3.6
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Description-Content-Type: text/markdown
