Skip to content

Commit

Permalink
Update help documents
Browse files Browse the repository at this point in the history
  • Loading branch information
shuichiro-makigaki committed Jan 31, 2020
1 parent d753096 commit cd6c309
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 15 deletions.
5 changes: 1 addition & 4 deletions .github/workflows/pythonpublish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Set up Python
uses: actions/setup-python@v1
with:
python-version: '3.7'
- uses: actions/setup-python@v1
- name: Install dependencies
run: |
python -m pip install --upgrade pip
Expand Down
3 changes: 3 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,8 @@ FROM python
ARG SOURCE_BRANCH
RUN pip install git+https://github.com/shuichiro-makigaki/mendeley_cli@${SOURCE_BRANCH}

ENV MENDELEY_CLIENT_ID=9999
ENV MENDELEY_CLIENT_SECRET=dummy
ENV MENDELEY_REDIRECT_URI=http://localhost:8888
ENTRYPOINT [ "mendeley" ]
CMD [ "--help" ]
20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,24 @@
# mendeley_cli
# mendeley-cli
CLI for Mendeley

# Install

```
pip install mendeley_cli
pip install mendeley-cli
```

Docker image is also available.

```
docker image pull makisyu/mendeley
```

# How to get Mendeley API token

To create, update, and delete resources in your Mendeley library via Mendeley API, OAUTH2 flow is required.
We have to register and mark this mendeley_cli as a trusted application in your Mendeley (Elsevier) account by yourself.
We have to register and mark this mendeley-cli as a trusted application in your Mendeley (Elsevier) account by yourself.

## 1. Register mendeley_cli as a trusted app
## 1. Register mendeley-cli as a trusted app

https://dev.mendeley.com/myapps.html

Expand All @@ -22,9 +28,9 @@ Register a new app (if not exists)

All fields are required.

* **Application name** MendeleyCLI
* **Description** MendeleyCLI
* **RegirectURL** http://localhost:8888
* **Application name**: MendeleyCLI
* **Description**: MendeleyCLI
* **RegirectURL**: http://localhost:8888
* Port number is a variable; >1024 is recommended.
* Generate secret, and save it securely.
* Submit
Expand Down
5 changes: 3 additions & 2 deletions mendeley_cli/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -99,9 +99,10 @@ def cmd():
* MENDELEY_CLIENT_SECRET
* MENDELEY_TOKEN
* MENDELEY_REDIRECT_URI
* MENDELEY_OAUTH2_TOKEN_BASE64
"""
pass

Expand Down
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
from setuptools import setup, find_packages

setup(
name='mendeley_cli',
version='0.1.1',
name='mendeley-cli',
version='0.1.2',
packages=find_packages(),
include_package_data=True,
install_requires=Path('requirements.txt').read_text().splitlines(),
Expand Down

0 comments on commit cd6c309

Please sign in to comment.