Skip to content
/ me-api Public

An extensible, personal API with custom integrations (a fork of @danfang's me-api written in Python).

License

Notifications You must be signed in to change notification settings

myles/me-api

Repository files navigation

Build Status Build status Requirements Status

me-api

An extensible, personal API with custom integrations (a clone of danfang's me-api written in Python).

Development

You will need the following requirments:

Create a python virtual envourment:

$ mkvirtualenv com_mylesbraithwaite_api
(com_mylesbraithwaite_api) $

Install the python requirments:

(com_mylesbraithwaite_api) $ pip install --upgrade -r requirements.txt

Run the project:

(com_mylesbraithwaite_api) $ python api.py

Workflow

I am using git-flow to manage the development workflow. The branch master is current production code running on http://api.mylesbraithwaite.com/ and the branch develop is current staging code running on http://staging.api.mylesbraithwaite.com/.

Deploy

I am using Heroku for the production and staging web sites. Travis CI handles all the deploys if they pass the tests.

Staging

If the test past then Travis CI will deploy to the staging branch.

Production

Use git-flow to create a new release branch:

$ git flow release start <version>

Update the README.md file status images to point to the master branch and increment the version number in api.py.

When you are finished, finish and sigh the release branch:

$ git flow release finish -s <version>

Then just push the master branch and Travis CI will take care of the rest:

$ git push origin master
$ git push --tags

About

An extensible, personal API with custom integrations (a fork of @danfang's me-api written in Python).

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published