File tree Expand file tree Collapse file tree 1 file changed +20
-16
lines changed Expand file tree Collapse file tree 1 file changed +20
-16
lines changed Original file line number Diff line number Diff line change @@ -68,6 +68,7 @@ RESTIC_REPOSITORY=s3:s3.us-east-1.amazonaws.com/bucket_name
6868RESTIC_PASSWORD=thisdecryptsyourbackupsdontloseit
6969AWS_ACCESS_KEY_ID=< your access key id> 
7070AWS_SECRET_ACCESS_KEY=< your access key id> 
71+ CHECK_WITH_CACHE=true
7172#  snapshot prune rules
7273RESTIC_KEEP_DAILY=7
7374RESTIC_KEEP_WEEKLY=4
@@ -108,7 +109,25 @@ More `rcb` commands can be found in the [documentation].
108109
109110Contributions are welcome regardless of experience level.
110111
111- ## Local dev setup  
112+ ## Python environment  
113+ 
114+ Use [ ` uv ` ] ( https://docs.astral.sh/uv/ )  within the ` src/ `  directory to manage your development environment.
115+ 
116+ ``` bash 
117+ git clone https://github.com/lawndoc/stack-back.git
118+ cd  stack-back
119+ uv sync --directory src/
120+ ``` 
121+ 
122+ ## Running unit tests  
123+ 
124+ Make sure ` uv `  is already set up as shown above.
125+ 
126+ ``` bash 
127+ uv run --directory src/ pytest
128+ ``` 
129+ 
130+ ## Docker Compose testing  
112131
113132The git repository contains a simple local setup for development
114133
@@ -121,24 +140,9 @@ docker-compose up -d
121140docker stack deploy -c swarm-stack.yml test 
122141``` 
123142
124- In dev we should ideally start the backup container manually
125- 
126- ``` bash 
127- docker-compose run --rm backup sh
128- #  pip install the package in the container in editable mode to auto sync changes from host source
129- pip3 install -e . 
130- ``` 
131- 
132143Remember to enable swarm mode with ` docker swarm init/join `  and disable swarm
133144mode with ` docker swarm leave --force `  when needed in development (single node setup).
134145
135- ## Running Tests  
136- 
137- ``` bash 
138- pip install -r src/tests/requirements.txt
139- tox
140- ``` 
141- 
142146## Building Docs  
143147
144148``` bash 
 
 
   
 
     
   
   
          
    
    
     
    
      
     
     
    You can’t perform that action at this time.
  
 
    
  
    
      
        
     
       
      
     
   
 
    
    
  
 
  
 
     
    
0 commit comments