Skip to content

Repository files navigation

repo-card-v2

Stars Forks Watchers Contributors Issues Commit activity

Top language Open-Source Code size in bytes Branch Status License

ThePerson is an open-source Python simulation of a person living inside your computer. It features a central Person class that developers can expand with new attributes, behaviors, and quirks.

Our main goal is to help open-source developers, no matter beginner or experienced, to learn OOP and collaborate with other Python programmers while building something never been built before on GitHub (I think).


Why Contribute?

  • This project is beginner-friendly with plenty of support for newcomers.
  • The best way to learn OOP, and anything else, is by doing.
  • There are infinite possibilities and always more you can add to the project.

Read our Contributing Guidelines to get started!

📋 Completing Tasks

Completing tasks is the main feature of this repository. You can also help create your own tasks for others to complete (see Issue #144).

You can find tasks under the Issues tab on GitHub. These are issues labeled task and are contributions you can make with specific instructions and more guidance.

Read the Contributing Guidelines if you're interested in working on a task.

Click HERE to see available tasks (link filtered for pinned tasks or open tasks with no assignees)

🏡 Be Part of TheTown!

In the root directory of this repo, you will see the_town.py. Add yourself as an instance of Person!

Read out Contributing Guidelines to get started. Any PR not following the guidelines under "TheTown" will be closed.


How to Use

To try using the project yourself on your computer, follow these steps.

On the GitHub page:

  1. Click the green "Code" button
  2. Select "Download ZIP"
  3. Unzip the ZIP file on your machine.
  4. Extract any of the files in theperson to implement in your own projects!

Quick Start for Beginners

Before trying this out:

  1. Ensure you have Python installed on your computer. (Install the latest version here and follow installation procedures)
  2. Follow the steps here to download the program.

After downloading the source code:

  1. Open the_town.py with IDLE (the code editor that comes with your Python installation): Right-click the file → Open With... → IDLE
    • If IDLE doesn't appear as an option, open the IDLE app manually and select Open → 'the_town.py'
  2. Edit the code however you like.
  3. On the menu bar at the top of your screen (or the top of the window for Windows), select Run → Run Module
  4. Keep experimenting!

If you have any questions or would like assistance or guidance with coding in general, feel free to open a Discussion in this repository's GitHub page — experienced developers in our community will be happy to help you out.

❓ Questions/Requests

If you have a question or something to say, open a discussion [here] repo-disc, or leave a comment in an existing discussion.

📜 License

This project is licensed under the MIT License.


If you enjoyed contributing to this project or appreciate the concept, consider dropping us a star to help others discover it — 🙏

Releases

Packages

Used by

Contributors

Languages