README.md

Python.

---

This repo is made with the objective of showing the Python related codes i have written.
Feel free to contribute and send suggestions.

---

Table of Contents

• Python.
  • Table of Contents
  • Setup
    • Clone without Submodules
    • Clone with Submodules
    • Clone Submodules
  • Installation:
  • Run Python Code:
    • Dependencies
  • Contributing
  • License
    • Creative Commons Zero v1.0 Universal

Setup

Clone without Submodules

In order to clone this repository without the submodules (Scientific Research and Worked-Example-Miner), you can use the following command:

git clone https://github.com/BrenoFariasdaSilva/Python.git

Clone with Submodules

In order to clone this repository with the submodules (Scientific Research and Worked-Example-Miner), you can use the following command:

git clone --recurse-submodules https://github.com/BrenoFariasdaSilva/Python.git

Clone Submodules

In case you have already cloned the repository and forgot to clone the submodules (Scientific Research and Worked-Example-Miner), you can use the following command to clone the submodule:

git submodule init
git submodule update

Installation:

• Python Language:

  • Manually:

     # Python:
     sudo apt install python3 python3-venv python3-pip -y
     # sudo apt install python-is-python3
     
     # Jupyter using Pip
     pip install jupyterlab
     pip install notebook
     pip install ipykernel
     # Launch: jupyter-lab or jupyter notebook in terminal

  • Using ShellScript:

     chmod +x install.sh
     sudo ./install.sh

Run Python Code:

python3 ./{ProgramName}.py
# Example: python3 ./main.py 

Dependencies

1. Install the project dependencies with the following command:

make dependencies

or

pip install -r requirements.txt

Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. If you have suggestions for improving the code, your insights will be highly welcome. In order to contribute to this project, please follow the guidelines below or read the CONTRIBUTING.md file for more details on how to contribute to this project, as it contains information about the commit standards and the entire pull request process. Please follow these guidelines to make your contributions smooth and effective:

1. Set Up Your Environment: Ensure you've followed the setup instructions in the Setup section to prepare your development environment.

2. Make Your Changes:

   • Create a Branch: git checkout -b feature/YourFeatureName
   • Implement Your Changes: Make sure to test your changes thoroughly.
   • Commit Your Changes: Use clear commit messages, for example:
     • For new features: git commit -m "FEAT: Add some AmazingFeature"
     • For bug fixes: git commit -m "FIX: Resolve Issue #123"
     • For documentation: git commit -m "DOCS: Update README with new instructions"
     • For refactorings: git commit -m "REFACTOR: Enhance component for better aspect"
     • For snapshots: git commit -m "SNAPSHOT: Temporary commit to save the current state for later reference"
   • See more about crafting commit messages in the CONTRIBUTING.md file.

3. Submit Your Contribution:

   • Push Your Changes: git push origin feature/YourFeatureName
   • Open a Pull Request (PR): Navigate to the repository on GitHub and open a PR with a detailed description of your changes.

4. Stay Engaged: Respond to any feedback from the project maintainers and make necessary adjustments to your PR.

5. Celebrate: Once your PR is merged, celebrate your contribution to the project!

License

Creative Commons Zero v1.0 Universal

This project is licensed under the Creative Commons Zero v1.0 Universal, which means you are free to use, modify, and distribute the code, as long as you mention include the license and attribute you as the original author for the repository. See the LICENSE file for more details.