From f471db90775200961937bb92c4bec77ae52bad37 Mon Sep 17 00:00:00 2001 From: Khai Do Date: Wed, 24 Jun 2020 08:22:19 -0700 Subject: [PATCH] Misc updates * Update jcapi-python library versions * Remove README.rst, it's generated from pandoc build * Update doc with installation info [Resolves #9] --- .gitignore | 1 + README.md | 2 +- README.rst | 84 ------------------------------------------------ requirements.txt | 4 +-- setup.py | 6 ++-- 5 files changed, 7 insertions(+), 90 deletions(-) delete mode 100644 README.rst diff --git a/.gitignore b/.gitignore index f5d2071..3021d83 100644 --- a/.gitignore +++ b/.gitignore @@ -98,6 +98,7 @@ ENV/ # mkdocs documentation /site +README.rst # mypy .mypy_cache/ diff --git a/README.md b/README.md index 2b1aa17..fb91609 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ identify provider service. ### Install ```bash -pip install git+https://github.com/Sage-Bionetworks/jccli +pip install jccli@git+https://github.com/Sage-Bionetworks/jccli ``` ### Usage diff --git a/README.rst b/README.rst deleted file mode 100644 index e633ef1..0000000 --- a/README.rst +++ /dev/null @@ -1,84 +0,0 @@ -jccli -===== - -A command line client to manage `Jumpcloud `__ -identify provider service. - -Getting Started ---------------- - -Install -~~~~~~~ - -.. code:: bash - - pip install git+https://github.com/Sage-Bionetworks/jccli - -Usage -~~~~~ - -.. code:: bash - - Usage: jccli [OPTIONS] COMMAND [ARGS]... - - Run jccli. - - Options: - -k, --key TEXT Jumpcloud API key - -v, --verbosity LVL Either CRITICAL, ERROR, WARNING, INFO or DEBUG - --version Show the version and exit. - --help Show this message and exit. - - Commands: - create-group Create a Jumpcloud group - create-user Create a new Jumpcloud user - delete-group Delete a Jumpcloud group - delete-user Delete a jumpcloud user - sync Sync Jumpcloud with a data file - -Contributions -------------- - -Contributions are welcome. - -Requirements: - -Install these utilities: \* `GNU -Make `__ \* -`pre-commit `__ \* -`Pandoc `__ - -As a pre-deployment step we syntatically validate our code and -configurations with pre-commit. - -Please install pre-commit, once installed the file validations will -automatically run on every commit. Alternatively you can manually -execute the validations by running ``pre-commit run --all-files``. - -Resources ---------- - -Below are some handy resource links. - -- `Project Documentation `__ -- `Click `__ is a Python package for - creating beautiful command line interfaces in a composable way with - as little code as necessary. -- `Sphinx `__ is a tool that - makes it easy to create intelligent and beautiful documentation, - written by Geog Brandl and licnsed under the BSD license. -- `pytest `__ helps you write - better programs. -- `GNU Make `__ is a tool which - controls the generation of executables and other non-source files of - a program from the program’s source files. - -Authors -------- - -- **zaro0508** - *Initial work* - - `github `__ - -See also the list of -`contributors `__ who -participated in this project. diff --git a/requirements.txt b/requirements.txt index 30b4727..debdda5 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,7 +1,7 @@ click>=7.0,<8 click-log>=0.3.0,<0.4.0 -jcapiv1@git+https://github.com/TheJumpCloud/jcapi-python.git@v3.3.0#subdirectory=jcapiv1 -jcapiv2@git+https://github.com/TheJumpCloud/jcapi-python.git@v3.3.0#subdirectory=jcapiv2 +jcapiv1@git+https://github.com/TheJumpCloud/jcapi-python.git@v4.0.0#subdirectory=jcapiv1 +jcapiv2@git+https://github.com/TheJumpCloud/jcapi-python.git@v4.0.0#subdirectory=jcapiv2 mock>=2.0.0,<2.1.0 pip-check-reqs>=2.0.1,<3 diff --git a/setup.py b/setup.py index af0bed4..01a656f 100644 --- a/setup.py +++ b/setup.py @@ -3,7 +3,7 @@ """ .. currentmodule:: setup.py -.. moduleauthor:: zaro0508 +.. moduleauthor:: sageit This file is used to create the package we'll publish to PyPI. """ @@ -64,8 +64,8 @@ ] }, license='Apache Software License', # noqa - author='zaro0508', - author_email='zaro0508@gmail.com', + author='sageit', + author_email='it@sagebase.org', # Use the URL to the github repo. url= 'https://github.com/Sage-Bionetworks/jccli', download_url=(