scottk/wlan-lanforge-scripts
1
0
Fork 0
mirror of https://github.com/Telecominfraproject/wlan-lanforge-scripts.git synced 2025-11-03 20:27:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

adds notes on .pypirc file

Browse Source
This commit is contained in:
Jed Reynolds
2020-03-30 10:37:43 -07:00
parent 9503fc553d
commit a7902d65ab
1 changed files with 22 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@@ -22,11 +22,6 @@ these scripts are more modern and may be a good place to start:
The `lf_wifi_rest_example.pl` script shows how one might call the other scripts from
within a script.
### Installation ###
These scripts call each other and rely on the structure of this directory. To use these scripts in other locations,
such as your laptop, either copy the entire scripts directory or do a __git clone__ of this repository. Just copying
one script to a separate directory is going to break its requirements.
### Examples and Documents ###
Read more examples in the [scripting LANforge](http://www.candelatech.com/lfcli_api_cookbook.php) cookbook.
@@ -93,6 +88,11 @@ Read more examples in the [scripting LANforge](http://www.candelatech.com/lfcli_
Scripts will be kept backwards and forwards compatible with LANforge
releases as much as possible.
### Installation ###
These scripts call each other and rely on the structure of this directory. To use these scripts in other locations,
such as your laptop, either copy the entire scripts directory or do a __git clone__ of this repository. Just copying
one script to a separate directory is going to break its requirements.
### Requirements ###
The perl scripts require the following perl packages to be installed. Most of these
perl packages are available through your repository as `.deb` or `.rpm` packages.
@@ -103,6 +103,23 @@ perl packages are available through your repository as `.deb` or `.rpm` packages
| JSON | perl-JSON | Yes, for JSON parsing |
| JSON::PrettyPrint | perl-JSON-PP | No, useful for debugging |
#### Pip v Pip3 ####
Please use pip3, we are targeting Python 3 with our scripts. If your pip/pip3 repositories have a difficult time connecting,
it's likely that you are trying to download from **pypi.python.org**. This is a deprecated location. Please update
using the **pypi.org** servers. Consider updating your ``~/.pypirc`` file:
````
[distutils]
index-servers =
  pypi
[pypi]
repository: https://upload.pypi.org/legacy/
````
As [described on Python.org](https://packaging.python.org/guides/migrating-to-pypi-org/).
### License ###
Code in this repository is released under the BSD license (see license.txt).