mirror of
				https://github.com/enpaul/tox-poetry-installer.git
				synced 2025-11-04 07:46:06 +00:00 
			
		
		
		
	Add basic usage instructions
Add badges
This commit is contained in:
		
							
								
								
									
										44
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										44
									
								
								README.md
									
									
									
									
									
								
							@@ -1,11 +1,49 @@
 | 
				
			|||||||
# tox-poetry-installer
 | 
					# tox-poetry-installer
 | 
				
			||||||
 | 
					
 | 
				
			||||||
A [Tox](https://tox.readthedocs.io/en/latest/) plugin for installing Tox environment
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					A [Tox](https://tox.readthedocs.io/en/latest/) plugin for installing test environment
 | 
				
			||||||
dependencies using [Poetry](https://python-poetry.org/) from the Poetry lockfile.
 | 
					dependencies using [Poetry](https://python-poetry.org/) from the Poetry lockfile.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
⚠️ **This project is a very, very early prototype and should not be used in any production
 | 
					⚠️ **This project is an early prototype and should not be used in any production capacity.**
 | 
				
			||||||
capacity.**
 | 
					 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## Usage
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					1. Install the plugin from PyPI:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					poetry add tox-poetry-installer --dev
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					2. Remove all version specifications from the environment dependencies in `tox.ini`:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					```ini
 | 
				
			||||||
 | 
					# This...
 | 
				
			||||||
 | 
					[testenv]
 | 
				
			||||||
 | 
					description = My cool test environment
 | 
				
			||||||
 | 
					deps =
 | 
				
			||||||
 | 
					    requests >=2.19,<3.0
 | 
				
			||||||
 | 
					    toml == 0.10.0
 | 
				
			||||||
 | 
					    pytest >=5.4
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					# ...becomes this:
 | 
				
			||||||
 | 
					[testenv]
 | 
				
			||||||
 | 
					description = My cool test environment
 | 
				
			||||||
 | 
					deps =
 | 
				
			||||||
 | 
					    requests
 | 
				
			||||||
 | 
					    toml
 | 
				
			||||||
 | 
					    pytest
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					3. Run Tox and force recreating environments:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					poetry run tox --recreate
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					4. 💸 Profit 💸
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## Why would I use this?
 | 
					## Why would I use this?
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 
 | 
				
			|||||||
		Reference in New Issue
	
	Block a user