Skip to content

Data_preprocessing from PDF to JSON#10

Open
roche-jeethan wants to merge 11 commits intosceptix-club:mainfrom
roche-jeethan:sub
Open

Data_preprocessing from PDF to JSON#10
roche-jeethan wants to merge 11 commits intosceptix-club:mainfrom
roche-jeethan:sub

Conversation

@roche-jeethan
Copy link
Copy Markdown

@rachan2005
Copy link
Copy Markdown
Contributor

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