Skip to content

Commit 0b27a54

Browse files
committed
update README.md
1 parent ad5398e commit 0b27a54

1 file changed

Lines changed: 45 additions & 44 deletions

File tree

README.md

Lines changed: 45 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -365,50 +365,6 @@ else:
365365
print(f"Error {response.status_code}: {response.data}")
366366
```
367367

368-
## Development and Testing
369-
370-
For contributors and advanced users:
371-
372-
### Development Setup
373-
374-
```bash
375-
# Clone the repository
376-
git clone https://github.com/tmunzer/mistapi_python.git
377-
cd mistapi_python
378-
379-
# Install with development dependencies
380-
pip install -e ".[dev]"
381-
382-
# Run tests
383-
pytest
384-
385-
# Run tests with coverage
386-
pytest --cov=src/mistapi --cov-report=html
387-
388-
# Run linting
389-
ruff check src/
390-
```
391-
392-
### Package Structure
393-
394-
```
395-
src/mistapi/
396-
├── __init__.py # Main package exports
397-
├── __api_session.py # Session management and authentication
398-
├── __api_request.py # HTTP request handling
399-
├── __api_response.py # Response parsing and pagination
400-
├── __logger.py # Logging configuration
401-
├── __pagination.py # Pagination utilities
402-
├── cli.py # Interactive CLI functions
403-
├── __models/ # Data models (privileges, etc.)
404-
└── api/v1/ # Auto-generated API endpoints
405-
├── const/ # Constants and enums
406-
├── orgs/ # Organization-level APIs
407-
├── sites/ # Site-level APIs
408-
├── login/ # Authentication APIs
409-
└── utils/ # Utility functions
410-
```
411-
412368
## Supported Mist Clouds
413369

414370
The package supports all Mist cloud instances:
@@ -474,6 +430,51 @@ events = mistapi.api.v1.orgs.clients.searchOrgClientsEvents(
474430
)
475431
```
476432

433+
## Development and Testing
434+
435+
For contributors and advanced users:
436+
437+
### Development Setup
438+
439+
```bash
440+
# Clone the repository
441+
git clone https://github.com/tmunzer/mistapi_python.git
442+
cd mistapi_python
443+
444+
# Install with development dependencies
445+
pip install -e ".[dev]"
446+
447+
# Run tests
448+
pytest
449+
450+
# Run tests with coverage
451+
pytest --cov=src/mistapi --cov-report=html
452+
453+
# Run linting
454+
ruff check src/
455+
```
456+
457+
### Package Structure
458+
459+
```
460+
src/mistapi/
461+
├── __init__.py # Main package exports
462+
├── __api_session.py # Session management and authentication
463+
├── __api_request.py # HTTP request handling
464+
├── __api_response.py # Response parsing and pagination
465+
├── __logger.py # Logging configuration
466+
├── __pagination.py # Pagination utilities
467+
├── cli.py # Interactive CLI functions
468+
├── __models/ # Data models (privileges, etc.)
469+
└── api/v1/ # Auto-generated API endpoints
470+
├── const/ # Constants and enums
471+
├── orgs/ # Organization-level APIs
472+
├── sites/ # Site-level APIs
473+
├── login/ # Authentication APIs
474+
└── utils/ # Utility functions
475+
```
476+
477+
477478
## Contributing
478479

479480
Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

0 commit comments

Comments
 (0)