Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
T
Textgrid Repository WebDAV Server
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
DARIAH-DE
TextGridRep
Textgrid Repository WebDAV Server
Commits
02f8165d
Verified
Commit
02f8165d
authored
3 years ago
by
Stefan Hynek
Browse files
Options
Downloads
Patches
Plain Diff
docs(readme): describe development and contributing
parent
c6cc9dfc
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+51
-0
51 additions, 0 deletions
README.md
with
51 additions
and
0 deletions
README.md
+
51
−
0
View file @
02f8165d
# repdav
# repdav
## Development
1.
Prerequisites
-
Python 3.8
-
Docker 20.10
-
Docker Compose 1.25
1.
Create/activate virtual environment (ensure you use the correct python version!).
```sh
python -m venv venv
. venv/bin/activate
```
1.
Install requirements.
```sh
pip install $(cat requirements.txt requirements.dev.txt)
```
1.
Configure the service by setting the following variables either in your environment or in the
`docker-compose.yml`
file.
-
host
-
port
-
tg_auth_wsdl
-
tg_auth_address
1.
Start the service.
```sh
python main.py
```
For your convenience, a Docker Compose setup is delivered with this repository that configures the service accordingly. Build and start the stack.
```
sh
docker-compose up
--build
```
## Contributing
Commit convention:
-
Use
[
conventional commits
](
https://www.conventionalcommits.org/en/v1.0.0/
)
Style constraints:
-
Code:
[
PEP 8
](
https://www.python.org/dev/peps/pep-0008/
)
-
Documentation:
[
PEP 287
](
https://www.python.org/dev/peps/pep-0287/
)
Coding constraints:
-
Objects that are not supposed to be used outside the current scope MUST be named starting with
`_`
(underscore):
[
PEP 316
](
https://www.python.org/dev/peps/pep-0316/#id12
)
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment