general-plan-map-python

A python implimentation of the General Plan Searching website

https://github.com/ucdavis/general-plan-map-python

Science Score: 39.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 2 DOI reference(s) in README
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (9.6%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

A python implimentation of the General Plan Searching website

Basic Info
  • Host: GitHub
  • Owner: ucdavis
  • License: gpl-3.0
  • Language: Python
  • Default Branch: new_server
  • Size: 30.4 MB
Statistics
  • Stars: 2
  • Watchers: 7
  • Forks: 4
  • Open Issues: 18
  • Releases: 5
Created over 5 years ago · Last pushed over 1 year ago
Metadata Files
Readme License Zenodo

README.md

General-Plan-Map

How to Access

You can access a working version of this application here.

About

Each city and county in California is required to produce a General Plan, a document that outlines and commits local governments to long-term development goals. Planning laws in the State of California mandate that every General Plan address a common set of issues, including Land Use, Conservation, and Housing. However, such laws do not specify where in the General Plan such issues need to be addressed or the format of the Plan overall. Thus, while General Plans offer the most comprehensive blueprint for future visioning of cities and counties throughout California, the structure and format of the Plans vary considerably across cities and counties. This makes it difficult to readily compare planning approaches across the state, to comparatively evaluate progress towards planning goals, and to set benchmarks for policy success.

This project is developing a platform for readily querying and extracting snippets of information about issues such as planned housing across all General Plans. Currently, there are no states that have such a public database for querying General Plans state-wide. The platform is expected to become a key policy implementation and enforcement infrastructure for the California OPR, a resource for community developers in collaborative planning, and a valuable information source for community members and researchers.

The Tool

The General Plan Database Mapping Tool provides access to the text of California city and county General Plans and enables users to identify the plans in which a queried phrase is referenced. Upon searching, the tool filters a map to the cities in CA with General Plans that reference the phrase, offering a geospatial representation of its use. The tool also links to the plans that reference the search phrase.

Contributors

| Contributions | Name | | ----: | :---- | | 💻 🚇 📖 🤔 | Aniket Banginwar | 💻 🚇 🤔 | Dexter Antonio | 💻 📖 🤔 | Mirthala Lopez | 📆 🧑‍🏫 🚇 📖 🤔 | Lindsay Poirier | 💻 🚇 🤔 | Sujoy Ghosh | 💻 🚇 🤔 | Makena Dettman | 📆 🔬 🔣 🤔 | Catherine Brinkley

(For a key to the contribution emoji or more info on this format, check out “All Contributors.”)

How to Contribute

  1. File an issue via this repo's issue queue.

  2. Write code to fix issues or to create new features. When contributing code, please be sure to:

  • Fork this repository, modify the code (changing only one thing at a time), and then issue a pull request for each change.
  • Follow the project's coding style (using K&R-style indentation and bracketing, commenting above each feature, and using snake case for variables).
  • Test your code locally before issuing a pull request.
  • Clearly state the purpose of your change in the description field for each commit.

Architecture

textsearch.py contains most of the code for searching the pdfs, creating the maps and tables, and displaying the maps and tables. uploader.py contains the code for uploading new pdfs, emailing the recipient of choice, and generating the searchable text document.

The data, including the shapefiles and population data for both the cities and counties are found in /static/data/. The code also looks for a folder named places inside /static/data/ which is where .pdfs and their corresponding .txt documents will be stored.

The .html templates are stored in /templates/. These templates contain references which are passed from textsearch.py. There are also dependencies on .css and .js code stored in /static/cssjs/css and /static/cssjs/js respectively. The images found on the site are stored in /static/images/.

Dependencies

Setting up Your Environment

Please follow the install guide on setting up a local version of the repository for testing and development.

Copyrights

Please see license file for details.

Cite As

Aniket Banginwar, Dexter Antonio, Mirthala Lopez, Lindsay Poirier, Sujoy Ghosh, Makena Dettmann, & Catherine Brinkley. (2023, January 6). General Plan Database Mapping Tool (v3.0). Zenodo. https://doi.org/10.5281/zenodo.7508689

Have Questions?

Contact hack-for-california@ucdavis.edu

Owner

  • Name: UC Davis
  • Login: ucdavis
  • Kind: organization
  • Email: github@ucdavis.edu
  • Location: University of California, Davis

GitHub Events

Total
  • Push event: 6
Last Year
  • Push event: 6

Issues and Pull Requests

Last synced: over 1 year ago

All Time
  • Total issues: 34
  • Total pull requests: 44
  • Average time to close issues: 7 months
  • Average time to close pull requests: 8 days
  • Total issue authors: 3
  • Total pull request authors: 7
  • Average comments per issue: 0.53
  • Average comments per pull request: 0.07
  • Merged pull requests: 36
  • Bot issues: 0
  • Bot pull requests: 1
Past Year
  • Issues: 0
  • Pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 1
Top Authors
Issue Authors
  • DexterAntonio (20)
  • lindsaypoirier (13)
  • sprucely (1)
Pull Request Authors
  • lindsaypoirier (15)
  • DexterAntonio (10)
  • Epsian (7)
  • mirthala-lopez (6)
  • aniketb97 (3)
  • srkirkland (2)
  • dependabot[bot] (2)
Top Labels
Issue Labels
Pull Request Labels
dependencies (2)

Dependencies

requirements.txt pypi
  • Django ==3.0.3
  • Fiona ==1.8.4
  • Flask ==1.1.2
  • Flask-Bootstrap ==3.3.7.1
  • Flask-Mail ==0.9.1
  • Flask-Simple-GeoIP ==0.2.4
  • Jinja2 ==2.11.2
  • MarkupSafe ==1.1.1
  • Pillow ==8.0.0
  • PyDrive ==1.3.1
  • PyMuPDF ==1.18.1
  • PyPDF2 ==1.26.0
  • PySocks ==1.7.1
  • PyYAML ==5.3.1
  • Shapely ==1.6.4
  • Werkzeug ==0.16.0
  • aiohttp ==3.7.4.post0
  • asgiref ==3.2.7
  • astroid ==2.4.2
  • async-timeout ==3.0.1
  • atom ==0.6.0
  • attrs ==20.2.0
  • backoff ==1.10.0
  • bcrypt ==3.2.0
  • blinker ==1.4
  • bokeh ==2.2.2
  • brotlipy ==0.7.0
  • cachetools ==4.1.1
  • certifi ==2020.12.5
  • cffi ==1.14.0
  • chardet ==3.0.4
  • ci-info ==0.2.0
  • click ==7.1.2
  • click-plugins ==1.1.1
  • cligj ==0.6.0
  • configobj ==5.0.6
  • configparser ==5.0.1
  • cryptography ==3.1.1
  • decorator ==4.4.2
  • distro ==1.5.0
  • dominate ==2.5.2
  • elasticsearch ==7.9.1
  • etelemetry ==0.2.2
  • filelock ==3.0.12
  • future ==0.18.2
  • geojson ==2.5.0
  • geopandas ==0.9.0
  • ghostscript ==0.6
  • google-api-core ==1.22.2
  • google-api-python-client ==1.12.3
  • google-auth ==1.22.0
  • google-auth-httplib2 ==0.0.4
  • googleapis-common-protos ==1.52.0
  • httplib2 ==0.18.1
  • idna ==2.10
  • idna-ssl ==1.1.0
  • importlib-metadata ==4.0.1
  • iniconfig ==1.1.1
  • ipaddress ==1.0.23
  • isodate ==0.6.0
  • isort ==5.6.4
  • itsdangerous ==1.1.0
  • lazy-object-proxy ==1.4.3
  • lxml ==4.6.1
  • mccabe ==0.6.1
  • more-itertools ==8.6.0
  • multidict ==4.7.5
  • munch ==2.5.0
  • networkx ==2.5
  • nibabel ==3.2.0
  • nipype ==1.5.1
  • numpy ==1.19.2
  • oauth2client ==4.1.3
  • packaging ==20.4
  • pandas ==1.1.3
  • pkg-resources ==0.0.0
  • pluggy ==0.13.1
  • protobuf ==3.15.8
  • prov ==1.5.3
  • py ==1.10.0
  • pyOpenSSL ==19.1.0
  • pyasn1 ==0.4.8
  • pyasn1-modules ==0.2.7
  • pycparser ==2.20
  • pydot ==1.4.1
  • pydotplus ==2.0.2
  • pylint ==2.6.0
  • pyparsing ==2.4.7
  • pyproj ==3.0.1
  • pyshp ==2.1.2
  • pytesseract ==0.3.7
  • pytest ==6.2.2
  • python-dateutil ==2.8.1
  • pytz ==2020.1
  • pyxnat ==1.3
  • rdflib ==5.0.0
  • requests ==2.24.0
  • rope ==0.18.0
  • rsa ==4.6
  • scipy ==1.5.3
  • simple-geoip ==0.1.1
  • simplejson ==3.17.2
  • six ==1.15.0
  • sqlparse ==0.3.1
  • toml ==0.10.1
  • tornado ==6.0.4
  • traits ==6.1.1
  • typed-ast ==1.4.3
  • typing-extensions ==3.7.4.3
  • uritemplate ==3.0.1
  • urllib3 ==1.25.11
  • visitor ==0.1.3
  • wrapt ==1.11.2
  • yarl ==1.6.2
  • zipp ==3.4.1
  • zstd ==1.4.5.0
.github/workflows/codeql-analysis.yml actions
  • actions/checkout v2 composite
  • github/codeql-action/analyze v1 composite
  • github/codeql-action/autobuild v1 composite
  • github/codeql-action/init v1 composite
Dockerfile docker
  • python 3.8 build