Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
pjsier committed Sep 9, 2019
0 parents commit b6ce89c
Show file tree
Hide file tree
Showing 24 changed files with 56,223 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitattributes
@@ -0,0 +1 @@
tests/files/* linguist-generated
134 changes: 134 additions & 0 deletions .gitignore
@@ -0,0 +1,134 @@
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
env/
build/
develop-eggs/
dist/
docs/_site/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
*.egg-info/
.installed.cfg
*.egg

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
.pytest_cache
*.cover
.hypothesis/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy
tutorial/

# Sphinx documentation
docs/_build/

# PyBuilder
target/

# Jupyter Notebook
.ipynb_checkpoints

# pyenv
.python-version

# celery beat schedule file
celerybeat-schedule

# SageMath parsed files
*.sage.py

# dotenv
.env

# IDEs and editors
/.idea
.vscode
.project
.classpath
.c9/
*.launch
.settings/
*.sublime-workspace

# virtualenv
.venv
venv/
ENV/
documenters-aggregator/
city-scrapers/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/

# cyrus
json_conversions.md
.citybureau/
city_scrapers/caps.py

# legistar cache
_cache/

# src dir from git commit packages in requirements.txt
src/

# OS files
.DS_Store

# validation logs
logs/*.log
travis/*.json
27 changes: 27 additions & 0 deletions .travis.yml
@@ -0,0 +1,27 @@
language: python
python:
- 3.5
- 3.6
- 3.7-dev
install:
- pip install pipenv
- pipenv install --ignore-pipfile --dev --three --system
script:
- isort --check-only --diff || exit 1
- yapf --diff --recursive ./city_scrapers/ ./tests/ || exit 1
- flake8
- pytest
- scrapy validate
before_deploy:
- export PYTHONPATH=$(pwd):$PYTHONPATH
- export SCRAPY_SETTINGS_MODULE=city_scrapers.settings.prod
deploy:
- skip_cleanup: true
provider: script
script: scrapy runall -s LOG_ENABLED=False
on:
python: 3.6
branch: master
condition: $TRAVIS_EVENT_TYPE = cron
after_deploy:
- scrapy combinefeeds -s LOG_ENABLED=False
50 changes: 50 additions & 0 deletions CODE_OF_CONDUCT.md
@@ -0,0 +1,50 @@
# City Scrapers Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion and spiritual beliefs, or sexual identity and orientation.

## Our Aim

The goal of this project is to create a central database of public events in Cleveland to be used by the City Bureau Documenters, journalists, activists, and engaged citizens (our use of “citizens” includes everyone who participates in or is impacted by a local government or municipality, including undocumented persons, disenfranchised voters and others often excluded from “Citizenship”).

## Our Standards

Examples of behavior that contributes to creating a positive environment include:

- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Seeking input, involvement and engagement from communities directly impacted by our work
- Respecting other community members personal preferences, such as gender pronouns
- Showing empathy towards other community members

## Examples of unacceptable behavior by participants include:

- The use of sexualized language or imagery and unwelcome sexual attention or advances
- Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or electronic address, without explicit permission
- Sustained disruption of group conversations or other community activities
- Other conduct which could reasonably be considered inappropriate in a professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at documenters@citybureau.org. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the Contributor Covenant, version 1.4,
available at http://contributor-covenant.org/version/1/4/
27 changes: 27 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,27 @@
## 1. Create a new issue to ask onboarding questions

We want the technical aspects of the project to be accessible to newcomers. As you're working through the set-up and installation, please create issues for roadblocks you encounter or anything that's confusing in the documentation. We're committed to helping you resolve these and improving the onboarding experience.

## 2. Open a Pull Request to talk about code and show us how things are going

In this project, making a Pull Request is a just way to start a conversation about a piece of code. :slightly_smiling_face: Opening a Pull Request helps us see how things are going. If you get stuck, you can use a Pull Request to show us your code and get feedback.

## 3. Use "WIP" to indicate that a Pull Request is incomplete

Prepend the title of all Pull Requests containing incomplete code with `WIP:`, which stands for _work-in-progress_. Once the code is done, remove `WIP:` from the title. This helps us prioritize PRs and know when you are "done" with your work.

## 4. Keep the tests green

We use Travis CI to check that tests pass and to maintain consistent style. Before marking your Pull Request as done, please make sure there are no failing checks and that the branch does not conflict with the master branch. A passing branch is indicated by green checkmarks at the bottom of the pull request page; a failing branch has red X’s.

If you have any questions about failing checks or merge conflicts, please reach out on Slack!

## 5. Inactive Pull Requests and Issues will be closed or reassigned

Pull Requests with no activity from the original contributor for 30 days will be closed and the work possibly reassigned. But feel free to reopen the Pull Request if you come back to it later and the work has still not been completed.

Likewise, issues without activity for 30 days may be reassigned or closed.

## 6. We will do our best to respond to you promptly

If you request feedback or ask questions in your Pull Request, a maintainer will respond in 5 days (and hopefully sooner). If you don't hear from us in that time, please ping us on Slack. We are not intentionally ignoring you, but from time to time, an email or message falls through the cracks. :wink:
21 changes: 21 additions & 0 deletions LICENSE
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2019 City Bureau

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
19 changes: 19 additions & 0 deletions Pipfile
@@ -0,0 +1,19 @@
[[source]]
url = "https://pypi.org/simple"
verify_ssl = true
name = "pypi"

[packages]
requests = "*"
twisted = "*"
scrapy = "*"
scrapy-sentry = "*"
legistar = {git = "https://github.com/opencivicdata/python-legistar-scraper"}
city-scrapers-core = {extras = ["azure"],version = "*"}

[dev-packages]
freezegun = "*"
pytest = "*"
"flake8" = "*"
isort = "*"
yapf = "*"

0 comments on commit b6ce89c

Please sign in to comment.