Skip to content

Commit

Permalink
fix readme rendering which was breaking pypi upload (#936)
Browse files Browse the repository at this point in the history
* fixed md error which stopped pypi rendering and therefore upload
  • Loading branch information
dunckerr authored Jan 10, 2022
1 parent 29a1ac3 commit 755b7e3
Showing 1 changed file with 26 additions and 16 deletions.
42 changes: 26 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,42 +24,52 @@ Arctic has been under active development at [Man AHL](https://www.man.com/ahl) s

### Install Arctic

```
``
pip install git+https://github.com/manahl/arctic.git
```
``

### Run a MongoDB

```
``
mongod --dbpath <path/to/db_directory>
```
``

### Using VersionStore

```
## Using VersionStore
``
from arctic import Arctic
import quandl
# Connect to Local MONGODB
``
### Connect to Local MONGODB
``
store = Arctic('localhost')
``

# Create the library - defaults to VersionStore
### Create the library - defaults to VersionStore
``
store.initialize_library('NASDAQ')
``

# Access the library
### Access the library
``
library = store['NASDAQ']
``

# Load some data - maybe from Quandl
### Load some data - maybe from Quandl
``
aapl = quandl.get("WIKI/AAPL", authtoken="your token here")
``

# Store the data in the library
### Store the data in the library
``
library.write('AAPL', aapl, metadata={'source': 'Quandl'})
``

# Reading the data
### Reading the data
``
item = library.read('AAPL')
aapl = item.data
metadata = item.metadata
```
``

VersionStore supports much more: [See the HowTo](howtos/how_to_use_arctic.py)!

Expand Down Expand Up @@ -88,7 +98,7 @@ itself is composed of a number of collections within the database. Libraries loo
* user.EOD
* user.ONEMINUTE

A library is mapped to a Python class. All library databases in MongoDB are prefixed with 'arctic_'
A library is mapped to a Python class. All library databases in MongoDB are prefixed with 'arctic\_'

### Storage Engines

Expand Down

0 comments on commit 755b7e3

Please sign in to comment.