Skip to content

Commit

Permalink
Updated readme with new sqlalchemy stubs
Browse files Browse the repository at this point in the history
  • Loading branch information
Stiivi committed Mar 29, 2017
1 parent 533083c commit eeb15e8
Showing 1 changed file with 6 additions and 14 deletions.
20 changes: 6 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,12 @@ Cubes - Online Analytical Processing Framework for Python

[![Join the chat at https://gitter.im/DataBrewery/cubes](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/DataBrewery/cubes?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)


IMPORTANT: 2.0 Development
==========================

[![Build Status](https://travis-ci.org/DataBrewery/cubes.svg?branch=2.0)](https://travis-ci.org/DataBrewery/cubes)

This branch is under development and might be unstable or broken, especially
during work on type annotations. To work on the 2.0 branch a special
environment must be set up.
Expand All @@ -17,22 +20,11 @@ publicly released.
Development Environment
-----------------------

### Typeshed

We need to get typeshed with changes that might not yet been merged with MyPy.

Download modified `typeshed`:

git clone https://github.com/stiivi/typeshed

Use custom typeshed while running mypy, for example:

mypy --custom-typeshed-dir ../typeshed
### Types for SQLAlchemy

Or add the option to the `mypy.ini` file:
We need to get type stubs for SQLAlchemy from: https://github.com/JelleZijlstra/sqlalchemy-stubs

[mypy]
custom_typeshed_dir = ../typeshed
Then set your `MYPYPATH` to the path with the `sqlalchemy-stubs`

-----------------------------------------------------------------------------

Expand Down

0 comments on commit eeb15e8

Please sign in to comment.