forked from gisce/heman
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
README: further explanation of the module and TODO's
- Loading branch information
Showing
1 changed file
with
17 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,25 +1,34 @@ | ||
He-Man | ||
====== | ||
# He-Man | ||
|
||
Uses the Empowering Sword (a.k.a Empowering Proxy API for users) | ||
Uses the Empowering Sword (a.k.a Empowering Proxy API for users). | ||
|
||
He-Man provides an authentified API to access several information regarding Som Energia users stored as objects in monogdb. | ||
|
||
- CCH curves from distribution | ||
- Photovoltaic simulations | ||
- Infoenergia profiles | ||
|
||
## Develoment Deployment | ||
|
||
```bash | ||
# then in your main one | ||
./setup.py develop | ||
cp heman.ini.example heman.ini | ||
# Edit the content to match your configuration | ||
|
||
# In different consoles run | ||
docker run -it --rm -p 27017:27017 mongo | ||
docker run -it --rm -p 6379:6379 redis | ||
|
||
# then in your main one | ||
./setup.py develop | ||
|
||
# to run the test | ||
pytest | ||
|
||
# to deploy locally | ||
MONGO_URI=mongodb://localhost python run_api.py | ||
|
||
``` | ||
|
||
## TODO | ||
|
||
- Discovering tests from heman/ fails since the api is created twice | ||
- Py3: Migrate to sentry-sdk, since raven library raven library is not Py3. | ||
|
||
|