Skip to content
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.

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

Reorganizing repo #144

Merged
merged 53 commits into from
Oct 21, 2024
Merged

Reorganizing repo #144

merged 53 commits into from
Oct 21, 2024

Conversation

danvk
Copy link
Owner

@danvk danvk commented Oct 20, 2024

General principles:

  • Keep data and code separate. Data lives in data, code lives in oldnyc.
  • Original sources of data go in data/originals. Derived data lives in data. This line can be a bit fuzzy.
  • Code lives under coherent subdirectories in oldnyc:
    • ingest: code used to produce images.ndjson
    • crop: finding and extracting photos and text from larger images
    • geocode: locating items
    • ocr: transcribing text from the ocrbacks
    • feedback: processing user feedback
    • site: generating the OldNYC site in oldnyc.github.io
    • analysis: code that is not part of the pipeline
  • One-off analysis scripts and notebooks all live under oldnyc/analysis.

Apparently __init__.py is no longer a thing. Also one does not name a file types.py. pyright and the e2e tests were extremely helpful in putting this together.

Working spreadsheet here.

@danvk danvk marked this pull request as ready for review October 20, 2024 13:49
@danvk danvk changed the title Begin reorganizing repo Reorganizing repo Oct 21, 2024
@danvk danvk merged commit 0d555d1 into master Oct 21, 2024
4 checks passed
@danvk danvk mentioned this pull request Oct 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant