Skip to content
This repository has been archived by the owner on Feb 6, 2023. It is now read-only.

Commit

Permalink
docs: Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
jjeff07 committed Jan 27, 2022
1 parent 7e47df8 commit 89eac20
Show file tree
Hide file tree
Showing 3 changed files with 100 additions and 58 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,30 @@ pip install ipfabric

## Introduction

Please take a look at [API Programmability - Part 1: The Basics](https://ipfabric.io/blog/api-programmability-part-1/)
for instructions on creating an API token.

Most of the methods and features can be located in [Examples](examples) to show how to use this package.
Another great introduction to this package can be found at [API Programmability - Part 2: Python](https://ipfabric.io/blog/api-programmability-python/)

## Authentication
### Basic
Please take a look at [basic.py](examples/basic.py) for basic authentication examples

### Environment
The easiest way to use this package is with a `.env` file. You can copy the sample and edit it with your environment variables.

```commandline
cp sample.env .env
```

This contains the following variables which can also be set as environment variables instead of a .env file.
```
IPF_URL="https://demo3.ipfabric.io"
IPF_TOKEN=TOKEN
IPF_VERIFY=true
```

## Development

IPFabric uses poetry for the python packaging module. Install poetry globally:
Expand Down
Loading

0 comments on commit 89eac20

Please sign in to comment.