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

Data_preprocessing from PDF to JSON #10

Open
wants to merge 10 commits into
base: main
Choose a base branch
from

Conversation

roche-jeethan
Copy link

@rachan2005
Copy link
Member

Hey @roche-jeethan ,

I checked out your repo, and you've done a great job!

However, I wanted to point out something important that I noticed right away. Including your virtual environment (env) in the repo isn’t recommended. It contains over 5000+ redundant files, making it impractical to load or clone.

The usual practice is to create a requirements.txt file that lists all the required packages. This way, anyone can easily download the necessary dependencies.

Here’s how you can fix this:

1. Create requirements.txt:

After setting up your environment, run the following command:

pip freeze > requirements.txt

This will generate a list of all installed packages in your environment.

2. Add your virtual environment to .gitignore:

To prevent the virtual environment folder from being included in your repository, add the following line to your .gitignore file:

/env

Make sure the name matches the folder name for your virtual environment (e.g., env, venv, or whatever it's called).

3. Push Changes:

Add and commit the .gitignore and requirements.txt files to your repo:

git add .gitignore requirements.txt
git commit -m "Exclude venv and add requirements.txt"
git push

This way, others can easily recreate the environment by running:

pip install -r requirements.txt

Remember this is incase of Python.

Thank you!

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.

2 participants