Git Repository SetupΒΆ
You will need basic familiarity with Git and have Git installed.
Clone the xlwings Server repo. Replace
myproject
with the name of your project:git clone https://github.com/xlwings/xlwings-server.git myproject
git clone git@github.com:xlwings/xlwings-server.git myproject
Change into the directory of your project:
cd myproject
Rename the remote from
origin
toupstream
:git remote rename origin upstream
Create your own (empty) Git repo
myproject
on GitHub or any other Git provider and copy the clone URL.Add the clone URL of your own Git repo:
git remote add origin <URL>
To prevent future merge conflicts with the
requirements
files, run:git config --local merge.ours.driver true
In the desired Python environment, install the development dependencies:
pip install -r requirements-dev.txt
Initialize the repo. This will create an
.env
file for configuration and will create unique UUIDs in theapp/config.py
file.python run.py init
Open the
.env
file and add your xlwings license key underXLWINGS_LICENSE_KEY
(top of the file). Note that.env
is ignored by Git as it may contain sensitive credentials. You should therefore back it up in a secure location such as a password manager.Commit the changes and push everything to your own repo (feel free to use a Git UI instead of the following commands):
git add . git commit -m "updated uuids" git push origin main