Welcome to BPZAround.me’s documentation!¶

Contents:

BPZAround.me¶

https://www.herokucdn.com/deploy/button.png

BPZAround.me alerts you when someone is building, planning, or zoning around you.

Free software: Apache License, Version 2.0
Documentation: https://bpzaroundme.readthedocs.org

Features¶

BPZAround.me is under development for the Tulsa, OK area. The planned features are:

Load neighborhoods, districts, and planning data from GeoJSON.
Find neighborhood associations and planning events (such as a re-zoning hearing) near your home.
Register to be notified by text or email when a planning event near you is scheduled.

Installation¶

Note

These are end-user installation instructions. If you want to contribute, see Get Started!

At the command line:

$ easy_install BPZAround.me

Or, if you have virtualenvwrapper installed:

$ mkvirtualenv BPZAround.me
$ pip install BPZAround.me

Usage¶

To use BPZAround.me in a project:

import BPZAround.me

Contributing¶

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions¶

Report Bugs¶

Report bugs at https://github.com/codefortulsa/BPZAround.me/issues.

If you are reporting a bug, please include:

Your operating system name and version.
Any details about your local setup that might be helpful in troubleshooting.
Detailed steps to reproduce the bug.

Fix Bugs¶

Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.

Implement Features¶

Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.

Write Documentation¶

BPZAround.me could always use more documentation, whether as part of the official BPZAround.me docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback¶

The best way to send feedback is to file an issue at https://github.com/codefortulsa/BPZAround.me/issues.

If you are proposing a feature:

Explain in detail how it would work.
Keep the scope as narrow as possible, to make it easier to implement.
Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!¶

Ready to contribute? Here’s how to set up BPZAround.me for local development.

Fork BPZAround.me on GitHub.

Clone your fork locally:

git clone git@github.com:your_name_here/BPZAround.me.git

Install requirements into a virtualenv. This is easiest with virtualenvwrapper:

mkvirtualenv BPZAround.me
cd BPZAround.me/
pip install -r requirements.txt -r requirements.dev.txt

Install PostGIS for GeoDjango.
Create a bpzaroundme PostGIS spatial database per the Post-installation instructions for your version of Postgres & PostGIS.:
Setup your local environment (Note: you can automate this with autoenv):
```
source .env
```
Make sure tests work:
```
$ ./manage.py test
```
Run it!:
```
$ ./manage.py runserver
```

Run on Heroku¶

Register for Heroku

Make Changes¶

Create a branch for local development:
```
$ git checkout -b name-of-your-bugfix-or-feature
```
Now you can make your changes locally.
When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:
```
$ make qa-all
```

Commit your changes and push your branch to GitHub:

$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

Submit a pull request through the GitHub website.

Pull Request Guidelines¶

Before you submit a pull request, check that it meets these guidelines:

The pull request should include tests.
If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
The pull request should work for Python 2.6, 2.7, 3.3, and 3.4, and for PyPy. Check https://travis-ci.org/codefortulsa/BPZAround.me/pull_requests and make sure that the tests pass for all supported Python versions.

Tips¶

To run a subset of tests:

$ python -m unittest tests.test_BPZAround.me