@@ -78,6 +78,61 @@ if __name__ == "__main__":
7878 uvicorn.run()
7979```
8080
81+ ## Python Virtual Environment Support
82+
83+ AtlasServer supports running applications within Python virtual environments, ensuring proper isolation and dependency management for your projects.
84+
85+ ### Automatic Environment Detection
86+
87+ When you specify a project directory, AtlasServer automatically scans for Python virtual environments:
88+
89+ 1 . ** Standard virtual environments** (venv, virtualenv)
90+ - Directories named: ` venv ` , ` .venv ` , ` env ` , ` .env ` , ` virtualenv ` , ` pyenv `
91+ - Any directory containing ` env ` in its name
92+
93+ 2 . ** Poetry environments**
94+ - Detected via ` poetry.lock ` or ` pyproject.toml ` files
95+ - Typically located in ` .venv ` within your project
96+
97+ 3 . ** Pipenv environments**
98+ - Detected via ` Pipfile `
99+ - Location determined by running ` pipenv --venv `
100+
101+ 4 . ** Conda environments**
102+ - Detected via ` environment.yml `
103+ - Matched with installed conda environments
104+
105+ ### Environment Configuration
106+
107+ When registering an application, you can:
108+
109+ 1 . ** Use automatic detection** (recommended)
110+ - Simply enter your project directory, and AtlasServer will detect and select the appropriate environment
111+
112+ 2 . ** Manually select an environment**
113+ - Choose from detected environments in the dropdown menu under "Advanced Options"
114+
115+ ### Ensuring Proper Detection
116+
117+ For reliable environment detection:
118+
119+ - ** Standard practice** : Create virtual environments in your project's root directory using standard names (` venv ` , ` .venv ` )
120+ - ** Custom environments** : Include "env" somewhere in the folder name for custom environments
121+ - ** Poetry/Pipenv** : Use the standard workflow (the environment will be detected automatically)
122+ - ** Conda** : Include an ` environment.yml ` file in your project directory
123+
124+ ### Environment Support Example
125+
126+ When using a virtual environment, your project structure might look like:
127+
128+ ```
129+ my_fastapi_project/
130+ ├── .venv/ # Virtual environment (auto-detected)
131+ ├── app.py # Main application file
132+ ├── requirements.txt # Dependencies
133+ └── ...
134+ ```
135+
81136## Coming Soon to AtlasServer Core
82137
83138We're working on adding support for more Python frameworks:
0 commit comments