Skip to content

Commit

Permalink
Include installation instructions for pipx too
Browse files Browse the repository at this point in the history
  • Loading branch information
simenheg committed May 28, 2024
1 parent b58f0c4 commit a57815d
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 6 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2019 Oslo Origo
Copyright (c) 2019-2024 Oslo Origo

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

Expand Down
34 changes: 30 additions & 4 deletions doc/install.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,19 @@
# Install

The quickest way to get started is by installing the latest release of Okdata
CLI from PyPI with pip (requires Python 3.8 or higher):
CLI from [PyPI](https://pypi.org/project/okdata-cli) with pip (requires Python
3.8 or higher):

```bash
python -m pip install --user okdata-cli
```

Alternatively by using [pipx](https://pipx.pypa.io):

```bash
pipx install okdata-cli
```

This will make the `okdata` command available to you. To verify that it is
installed properly and working, try listing all datasets:

Expand All @@ -21,7 +28,8 @@ If this succeeds you're ready to proceed with [configuration](configuration.md)!
Alternatively, Okdata CLI can be installed directly from source if you would
like to track updates before they appear in a proper PyPI release.

Start by cloning the Okdata CLI repository from GitHub:
Start by cloning the [Okdata CLI
repository](https://github.com/oslokommune/okdata-cli) from GitHub:

```bash
git clone https://github.com/oslokommune/okdata-cli.git
Expand All @@ -39,6 +47,12 @@ make init
This will install all necessary dependencies and make the `okdata` command
available inside the virtual environment.

Installation from source is also possible with pipx:

```bash
pipx install 'git+https://github.com/oslokommune/okdata-cli.git#egg=okdata-cli'
```

## Upgrade

If you have installed Okdata CLI with pip:
Expand All @@ -47,7 +61,13 @@ If you have installed Okdata CLI with pip:
python -m pip install --user --upgrade okdata-cli
```

If you have checked out the source from GitHub:
If you have installed Okdata CLI with pipx:

```bash
pipx upgrade okdata-cli
```

Or if you have checked out the source from GitHub:

```bash
git pull
Expand All @@ -62,6 +82,12 @@ If you have installed Okdata CLI with pip:
python -m pip uninstall okdata-cli
```

Otherwise simply remove the `okdata-cli` directory.
If you have installed Okdata CLI with pipx:

```bash
pipx uninstall okdata-cli
```

Otherwise simply remove the `okdata-cli` source directory.

To remove all traces of the program, remove the ` ~/.okdata` directory as well.
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
name="okdata-cli",
version="4.1.0",
author="Oslo Origo",
author_email="dataplattform@oslo.kommune.no",
author_email="dataspeilet@oslo.kommune.no",
description="CLI for services provided by Oslo Origo",
license="MIT",
long_description=long_description,
Expand Down

0 comments on commit a57815d

Please sign in to comment.