SG Viewer is a Python-based tool that allows users to view and interact with the ShotGrid Python Api.
- Python 3.6 or higher (https://www.python.org/downloads/)
- Git (https://git-scm.com/downloads)
Follow these steps to set up and run the SG Viewer project on your local machine:
- Clone the repository Clone the repository from GitHub to your local machine:
git clone https://github.com/rosborne132/sg-viewer.git
cd sg-viewer
- Set up the virtual environment Create and activate a virtual environment:
For Windows:
python3 -m venv venv
venv\Scripts\activate
For macOS and Linux:
python3 -m venv venv
source venv/bin/activate
- Install dependencies Install the required dependencies using pip:
pip install -r requirements.txt
- Run the application Execute the main.py script to start the SG Viewer:
python3 main.py
- Deactivate the virtual environment When you're done working on the project, deactivate the virtual environment:
deactivate
We welcome contributions to the SG Viewer project! Please follow these steps to contribute:
- Fork the repository on GitHub.
- Clone your fork to your local machine and follow the "Getting Started" steps above to set up the development environment.
- Create a new branch for your feature or bugfix (git checkout -b my-feature-branch).
- Make your changes and commit them to your feature branch.
- Push your changes to your fork on GitHub (git push origin my-feature-branch).
- Open a pull request on the original repository to propose your changes.