Skip to content

Getting started instructions, proposal for Black formatting #34

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
spra85 wants to merge 3 commits into
base: dev
Choose a base branch
from
Open

Getting started instructions, proposal for Black formatting #34

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3c65d21
Add basic instructions for getting a local env setup and running tests
spra85 Jan 20, 2024
248080e
Introduce Black Python formatting
spra85 Jan 20, 2024
a328aa0
Add comment clarifying flake8 ignore
spra85 Jan 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Both functions, and the class init, take an address string, or a dict-like objec
from scourgify import normalize_address_record, NormalizeAddress

normalize_address_record('123 southwest Main street, Boring, or, 97203')

normalize_address_record({
'address_line_1': '123 southwest Main street',
'address_line_2': 'unit 2',
Expand Down Expand Up @@ -155,6 +155,12 @@ Contributing
------------
Create a new branch to hold your change; no pull requests submitted directly to dev or master will be approved. Please include a comment explain the issue your pull request solves. Make sure all appropriate test, and tox, updates are included and that all tests are passing.

To setup a local environment and run tests:

```bash
tox
```

License
-------
usaddress-scourgify is released under the terms of the MIT license. Full details in LICENSE file.
Expand Down
2 changes: 1 addition & 1 deletion requirements/dev.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ pep8>=1.7.0
pylama>=7.3.3
pylint>=1.6.4
tox>=2.7.0

black>=23.12.1
2 changes: 1 addition & 1 deletion scourgify/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@
from scourgify.normalize import (
get_geocoder_normalized_addr,
normalize_address_record,
NormalizeAddress
NormalizeAddress,
)
Loading