Skip to content

Conversation

@leftkats
Copy link
Owner

@leftkats leftkats commented Jun 7, 2025

πŸš€ First Pull Request – Project Scaffold & Core Features

This is the initial pull request that sets up the foundation for the DataPytheon repository.
It includes the core structure, example data scripts, syncing utilities, testing, linting, and contribution tooling.
The goal is to offer a clean, collaborative, and beginner-friendly space for contributing data-related Python scripts.


βœ… What's Included

πŸ“ Project Structure

  • recipes/ β€” for ready-to-use data processing examples (e.g., titanic.py)
  • syncers/ β€” for syncing/ingesting data from public APIs (e.g., exchange rates)
  • tests/ β€” pytest-based unit tests for both syncers and recipes
  • requirements.txt β€” Python package requirements with seaborn==0.13.2

πŸ§ͺ Example Scripts

  • recipes/titanic.py β€” loads Titanic dataset using seaborn
  • syncers/exchange_rates.py β€” fetches real-time exchange rates via public API

βœ… Tests

  • Unit tests for both scripts to ensure functionality and structure

πŸ›  Tooling & Automation

  • GitHub Actions CI workflow: linting with ruff, testing with pytest + coverage
  • .coveragerc to include only recipes/ and syncers/, exclude all unnecessary files
  • Pre-commit configuration using ruff (line length set to 120)

πŸ“š Documentation & Community Files

  • README.md with project description, getting started, and emoji-enhanced friendliness :sparkles:
  • CONTRIBUTING.md with clear steps and contribution guidelines
  • CODE_OF_CONDUCT.md with inclusive behavior guidelines

πŸ“¦ Motivation

To create an open, educational, and valuable resource where contributors can easily add:

  • Simple data recipes
  • Public API syncers
  • Clean, tested, reusable Python code

πŸ›€οΈ Next Steps

  • Add more data recipes and syncers
  • Expand test coverage
  • Engage contributors through issues and good first tasks

@codecov-commenter
Copy link

Welcome to Codecov πŸŽ‰

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

ℹ️ You can also turn on project coverage checks and project coverage reporting on Pull Request comment

Thanks for integrating Codecov - We've got you covered β˜‚οΈ

@leftkats leftkats added the good first issue Good for newcomers label Jun 7, 2025
@leftkats leftkats merged commit e653848 into main Jun 7, 2025
1 check passed
@leftkats leftkats deleted the initial-idea branch July 17, 2025 18:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

good first issue Good for newcomers

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants