Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add install instructions to README #16

Open
maltfield opened this issue Sep 2, 2020 · 1 comment
Open

Add install instructions to README #16

maltfield opened this issue Sep 2, 2020 · 1 comment

Comments

@maltfield
Copy link

maltfield commented Sep 2, 2020

Please add instructions for how to fetch this package and use it to the "Usage" section to the README with

  1. a few commands that demonstrate how to install and use this package and
  2. an example execution of the above commands
@maltfield
Copy link
Author

maltfield commented Sep 2, 2020

Suggested install instructions (missing usage instructions):

sudo apt-get -y install python3 python3-pip
sudo pip3 install requests
sudo pip3 install kivy-garden
garden install navigationdrawer

Example execution of above install instructions:

user@disp3794:~$ sudo apt-get -y install python3 python3-pip
Reading package lists... Done
Building dependency tree       
Reading state information... Done
python3 is already the newest version (3.7.3-1).
python3 set to manually installed.
The following packages were automatically installed and are no longer required:
  linux-headers-4.19.0-6-amd64 linux-headers-4.19.0-6-common
  linux-image-4.19.0-6-amd64 python-daemon python-lockfile python-qubesdb
Use 'sudo apt autoremove' to remove them.
The following additional packages will be installed:
  dh-python libexpat1-dev libpython3-dev libpython3.7-dev python-pip-whl
  python3-dev python3-entrypoints python3-keyring python3-keyrings.alt
  python3-secretstorage python3-setuptools python3-wheel python3.7-dev
Suggested packages:
  gir1.2-gnomekeyring-1.0 python-secretstorage-doc python-setuptools-doc
The following NEW packages will be installed:
  dh-python libexpat1-dev libpython3-dev libpython3.7-dev python-pip-whl
  python3-dev python3-entrypoints python3-keyring python3-keyrings.alt
  python3-pip python3-secretstorage python3-setuptools python3-wheel
  python3.7-dev
0 upgraded, 14 newly installed, 0 to remove and 0 not upgraded.
Need to get 51.3 MB of archives.
After this operation, 90.2 MB of additional disk space will be used.
Get:1 https://deb.debian.org/debian buster/main amd64 dh-python all 3.20190308 [99.3 kB]
Get:2 https://deb.debian.org/debian buster/main amd64 libexpat1-dev amd64 2.2.6-2+deb10u1 [153 kB]
Get:3 https://deb.debian.org/debian buster/main amd64 libpython3.7-dev amd64 3.7.3-2+deb10u2 [48.4 MB]
Get:4 https://deb.debian.org/debian buster/main amd64 libpython3-dev amd64 3.7.3-1 [20.1 kB]
Get:5 https://deb.debian.org/debian buster/main amd64 python-pip-whl all 18.1-5 [1,591 kB]
Get:6 https://deb.debian.org/debian buster/main amd64 python3.7-dev amd64 3.7.3-2+deb10u2 [510 kB]
Get:7 https://deb.debian.org/debian buster/main amd64 python3-dev amd64 3.7.3-1 [1,264 B]
Get:8 https://deb.debian.org/debian buster/main amd64 python3-entrypoints all 0.3-1 [5,508 B]
Get:9 https://deb.debian.org/debian buster/main amd64 python3-secretstorage all 2.3.1-2 [14.2 kB]
Get:10 https://deb.debian.org/debian buster/main amd64 python3-keyring all 17.1.1-1 [43.1 kB]
Get:11 https://deb.debian.org/debian buster/main amd64 python3-keyrings.alt all 3.1.1-1 [18.2 kB]
Get:12 https://deb.debian.org/debian buster/main amd64 python3-pip all 18.1-5 [171 kB]
Get:13 https://deb.debian.org/debian buster/main amd64 python3-setuptools all 40.8.0-1 [306 kB]
Get:14 https://deb.debian.org/debian buster/main amd64 python3-wheel all 0.32.3-2 [19.4 kB]
Fetched 51.3 MB in 37s (1,393 kB/s)                                            
Selecting previously unselected package dh-python.
(Reading database ... 233325 files and directories currently installed.)
Preparing to unpack .../00-dh-python_3.20190308_all.deb ...
Unpacking dh-python (3.20190308) ...
Selecting previously unselected package libexpat1-dev:amd64.
Preparing to unpack .../01-libexpat1-dev_2.2.6-2+deb10u1_amd64.deb ...
Unpacking libexpat1-dev:amd64 (2.2.6-2+deb10u1) ...
Selecting previously unselected package libpython3.7-dev:amd64.
Preparing to unpack .../02-libpython3.7-dev_3.7.3-2+deb10u2_amd64.deb ...
Unpacking libpython3.7-dev:amd64 (3.7.3-2+deb10u2) ...
Selecting previously unselected package libpython3-dev:amd64.
Preparing to unpack .../03-libpython3-dev_3.7.3-1_amd64.deb ...
Unpacking libpython3-dev:amd64 (3.7.3-1) ...
Selecting previously unselected package python-pip-whl.
Preparing to unpack .../04-python-pip-whl_18.1-5_all.deb ...
Unpacking python-pip-whl (18.1-5) ...
Selecting previously unselected package python3.7-dev.
Preparing to unpack .../05-python3.7-dev_3.7.3-2+deb10u2_amd64.deb ...
Unpacking python3.7-dev (3.7.3-2+deb10u2) ...
Selecting previously unselected package python3-dev.
Preparing to unpack .../06-python3-dev_3.7.3-1_amd64.deb ...
Unpacking python3-dev (3.7.3-1) ...
Selecting previously unselected package python3-entrypoints.
Preparing to unpack .../07-python3-entrypoints_0.3-1_all.deb ...
Unpacking python3-entrypoints (0.3-1) ...
Selecting previously unselected package python3-secretstorage.
Preparing to unpack .../08-python3-secretstorage_2.3.1-2_all.deb ...
Unpacking python3-secretstorage (2.3.1-2) ...
Selecting previously unselected package python3-keyring.
Preparing to unpack .../09-python3-keyring_17.1.1-1_all.deb ...
Unpacking python3-keyring (17.1.1-1) ...
Selecting previously unselected package python3-keyrings.alt.
Preparing to unpack .../10-python3-keyrings.alt_3.1.1-1_all.deb ...
Unpacking python3-keyrings.alt (3.1.1-1) ...
Selecting previously unselected package python3-pip.
Preparing to unpack .../11-python3-pip_18.1-5_all.deb ...
Unpacking python3-pip (18.1-5) ...
Selecting previously unselected package python3-setuptools.
Preparing to unpack .../12-python3-setuptools_40.8.0-1_all.deb ...
Unpacking python3-setuptools (40.8.0-1) ...
Selecting previously unselected package python3-wheel.
Preparing to unpack .../13-python3-wheel_0.32.3-2_all.deb ...
Unpacking python3-wheel (0.32.3-2) ...
Setting up python3-entrypoints (0.3-1) ...
Setting up dh-python (3.20190308) ...
Setting up python3-setuptools (40.8.0-1) ...
Setting up python3-wheel (0.32.3-2) ...
Setting up libexpat1-dev:amd64 (2.2.6-2+deb10u1) ...
Setting up python3-secretstorage (2.3.1-2) ...
Setting up python3-keyrings.alt (3.1.1-1) ...
Setting up python3-keyring (17.1.1-1) ...
Setting up python-pip-whl (18.1-5) ...
Setting up libpython3.7-dev:amd64 (3.7.3-2+deb10u2) ...
Setting up python3.7-dev (3.7.3-2+deb10u2) ...
Setting up python3-pip (18.1-5) ...
Setting up libpython3-dev:amd64 (3.7.3-1) ...
Setting up python3-dev (3.7.3-1) ...
Processing triggers for man-db (2.8.5-2) ...
user@disp3794:~$ sudo pip3 install requests
Requirement already satisfied: requests in /usr/lib/python3/dist-packages (2.21.0)
user@disp3794:~$ 

user@disp3794:~$ sudo pip3 install kivy-garden
Collecting kivy-garden
  Downloading https://files.pythonhosted.org/packages/7d/68/decaee596ff8168a39432eb3949fc7c0be952ebb9467806823bffc165d48/kivy-garden-0.1.4.tar.gz
Requirement already satisfied: requests in /usr/lib/python3/dist-packages (from kivy-garden) (2.21.0)
Building wheels for collected packages: kivy-garden
  Running setup.py bdist_wheel for kivy-garden ... done
  Stored in directory: /root/.cache/pip/wheels/e5/09/36/4bec048252175b6aa7ba75441cbeed8f31a0bea37abedcfed0
Successfully built kivy-garden
Installing collected packages: kivy-garden
Successfully installed kivy-garden-0.1.4
user@disp3794:~$ 

user@disp3794:~$ garden install navigationdrawer
Downloading http://github.com/kivy-garden/garden.navigationdrawer/archive/master.zip ...
Progression 1024 | 
Progression 2048 / 
Progression 3072 - 
Progression 4096 \ 
Progression 5120 | 
Progression 6144 / 
Progression 7168 - 
Progression 8192 \ 
Progression 9216 | 
Progression 10240 / 
Progression 11264 - 
Progression 12288 \ 
Progression 13312 | 
Progression 14336 / 
Progression 15360 - 
Progression 16384 \ 
Progression 17408 | 
Progression 18432 / 
Progression 19456 - 
Progression 20480 \ 
Progression 21504 | 
Progression 22528 / 
Progression 23552 - 
Progression 24576 \ 
Progression 25600 | 
Progression 26624 / 
Progression 27648 - 
Progression 28672 \ 
Progression 29696 | 
Progression 30720 / 
Progression 31744 - 
Progression 32768 \ 
Progression 33792 | 
Progression 34816 / 
Progression 35840 - 
Progression 36864 \ 
Progression 37888 | 
Progression 38912 / 
Progression 39936 - 
Progression 40960 \ 
Progression 41984 | 
Progression 43008 / 
Progression 44032 - 
Progression 45056 \ 
Progression 46080 | 
Progression 47104 / 
Progression 48128 - 
Progression 49152 \ 
Progression 50176 | 
Progression 51200 / 
Progression 52224 - 
Progression 53248 \ 
Progression 54272 | 
Progression 55296 / 
Progression 56320 - 
Progression 57344 \ 
Progression 58368 | 
Progression 59392 / 
Progression 60416 - 
Progression 61440 \ 
Progression 62464 | 
Progression 63488 / 
Progression 64512 - 
Progression 65536 \ 
Progression 66560 | 
Progression 67584 / 
Progression 68608 - 
Progression 69632 \ 
Progression 70656 | 
Progression 71680 / 
Progression 72704 - 
Progression 73728 \ 
Progression 74752 | 
Progression 75776 / 
Progression 76800 - 
Progression 77824 \ 
Progression 78848 | 
Progression 79872 / 
Progression 80896 - 
Progression 81920 \ 
Progression 82944 | 
Progression 83968 / 
Progression 84992 - 
Progression 86016 \ 
Progression 87040 | 
Progression 87425 / 
Download done (87425 downloaded)
Extracting...
Installing new version...
Done! garden.navigationdrawer is installed at: /home/user/.kivy/garden/garden.navigationdrawer
Cleaning...
user@disp3794:~$ 

@maltfield maltfield changed the title Add usage instructions to README Add install instructions to README Sep 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant