https://github.com/jlumbroso/ptonppl
An integration package to deal with Princeton campus users.
https://github.com/jlumbroso/ptonppl
directory ldap princeton
Last synced: 6 months ago
JSON representation
An integration package to deal with Princeton campus users.
- Host: GitHub
- URL: https://github.com/jlumbroso/ptonppl
- Owner: jlumbroso
- License: lgpl-3.0
- Created: 2020-10-15T03:48:50.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2020-10-25T23:37:25.000Z (over 4 years ago)
- Last Synced: 2024-10-31T11:46:31.338Z (7 months ago)
- Topics: directory, ldap, princeton
- Language: Python
- Homepage: https://pypi.org/project/ptonppl/
- Size: 65.4 KB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ptonppl — Princeton People
This provides a Python package and a command-line tool to lookup the
campus directory of any member of the Princeton community. The package
provides a unified search function that queries the following fields:
- PUID, *e.g.*, `902312554`
- NetID, *e.g.*, `lumbroso`
- Alias, when the user has defined one, *e.g.*, `jeremie.lumbroso`
- Email, *e.g.*, `[email protected]`
This information is hard to come by consistently, and this tool seeks
to provide a robust interface to the information.
## Installation
The package is distributed on PyPI and can be installed using the usual
tools, such as `pip` or `pipenv`:
```shell
$ pip install --user ptonppl
```
## Help Message
```
$ ptonppl --help
Usage: ptonppl [OPTIONS] [QUERY]...
Lookup the directory information (PUID, NetID, email, name) of any
Princeton campus person, using whichever of LDAP, web directory or proxy
server is available.
Options:
-t, --type TYPE Output type (e.g.: term, json, csv, emails).
-u, --uniq / -nu, --not-uniq Filter out duplicate records from the output.
-s, --stats Display statistics once processing is done.
-i, --input FILENAME Read input from a file stream.
-f, --fields FIELDS Fields to keep (e.g.: 'puid,netid,email').
--header / -nh, --no-header Include or remove header in output.
--version Show the version and exit.
--help Show this message and exit.
```
## License
This project is licensed under the LGPLv3 license, with the understanding
that importing a Python modular is similar in spirit to dynamically linking
against it.
- You can use the library `ptonppl` in any project, for any purpose, as long
as you provide some acknowledgement to this original project for use of
the library.
- If you make improvements to `ptonppl`, you are required to make those
changes publicly available.