Git Repository Setup¶

Prerequisites¶

You will need basic familiarity with Git and have Git installed.
This guide assumes that you have Python installed.

Setup¶

Clone the xlwings Server repo. Replace myproject with the desired name of your project:
HTTPS
git clone https://github.com/xlwings/xlwings-server.git myproject
SSH
git clone git@github.com:xlwings/xlwings-server.git myproject
Note

If you only want to play around with xlwings Server without committing any changes back to Git, you can continue with Step 7. If you want to commit your changes later, you can always come back and follow the Steps 2-6.
Change into the directory of your project:
```
cd myproject
```
Rename the remote from origin to upstream:
```
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 reduce future merge conflicts with the help of .gitattributes, run:
```
git config --local merge.ours.driver true
```
Install the uv package manager:
```
pip install uv
```
In the desired Python environment, install the development dependencies:
```
uv pip sync -r requirements-dev.txt
```
Initialize the repo. This will create an .env file for configuration and will create unique UUIDs in the app/config.py file.
```
python run.py init
```
Open the .env file and add your xlwings license key under XLWINGS_LICENSE_KEY (top of the file).

Note

The .env file 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). If you just want to play around with xlwings Server, you can skip this step.
```
git add .
git commit -m "updated uuids"
git push origin main
```