Welcome to our project's repository! This README provides all the necessary information to get started with cloning the repository, setting up your development environment, collaborating with teammates, and running the project code.
To clone the repository and start working on the project, follow the instructions provided by GitHub at GitHub Docs on Cloning a Repository.
For additional Git guides and best practices, refer to Git Guides.
To switch to the master branch:
git checkout master
To rebase and update your local repository:
git pull --rebase
To work on a feature branch:
git checkout my-feature-branch
After implementing your feature, commit changes by only adding Python files (do not add __pycache__
or similar):
git add *.py
git commit -m "your message"
git push origin my-feature-branch
Before merging, rebase your branch onto master:
git rebase master
After rebasing, submit a pull request through the GitHub web interface. Wait for your peers to review your changes and merge them into the main branch.
Ensure Python is installed on your machine. To install Python, visit Python Downloads.
-
Navigate to the root project directory.
-
Activate the virtual environment:
- On macOS:
source scrapyenv/bin/activate
- On Windows:
scrapyenv\Scripts\activate
- On macOS:
Within the virtual environment, navigate to the rrid_project
directory and start the crawler:
cd rrid_project
scrapy crawl arxiv
# or
scrapy crawl biorxiv
If you encounter missing packages, install them using pip:
pip install package_name
Happy coding! 🚀