1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
|
# Update
Updating PyFunceble is as easy as the installation.
## Overview: Update Method
| OS | Technology | Tools | Link |
| --------- | --------------------------- | ------------ | ------------------------------------ |
| Any | PyPi - Python Package Index | `pip3` | [Link](#pypi---python-package-index) |
| Any | Container Image Registry | `docker` | [Link](#container-image-registry) |
| Any | Git | `pip3` | [Link](#git-repository) |
| Any | Zip File | `pip3` | [Link](#from-source) |
| ArchLinux | AUR Helper | `aur-helper` | [Link](#arch-linux) |
## PyPi - Python Package Index
Updating a `pip` installed package is straight forward. Just append `--upgrade` to
you installation command and you are good to go.
Here is an overview of the packages and where they are hosted.
| Package | PyPi Link |
|----------------|---------------------------------------------------------------------------------|
| pyfunceble | [https://pypi.org/project/PyFunceble](https://pypi.org/project/PyFunceble) |
| pyfunceble-dev | [https://pypi.org/project/PyFunceblee-dev](https://pypi.org/project/PyFunceble) |
!!! danger "Beware!!"
We recommend the usage of the `--user` flag as it installs the required
dependencies at the user level. The main reason behind that is to avoid
crashes or clashes between you OS package manager and `pip3`.
However, if you:
- are aware of the possible consequences
- are running PyFunceble within a CI engine or in an automated environment
you shouldn't use it.
### pyfunceble
You can update the **pyfunceble** through `pip3`:
```shell
pip3 install --user --upgrade pyfunceble
```
### pyfunceble-dev
You can update the **pyfunceble-dev** package through `pip3`:
```shell
pip3 install --user --upgrade pyfunceble-dev
```
If you want to help and use the unstable pre-releases, you should update with
the `--pre` argument.
```shell
pip3 install --user --pre --upgrade pyfunceble-dev
```
## Container Image Registry
Updating from a Container Image Registry is easier. If you allowed your container
engine to automatically pull the `latest` tag, you have nothing to do. The new
layers are downloaded before you run PyFunceble.
Here is an overview of the packages and where they are hosted.
| Host | Package | Link |
|------------|----------------|----------------------------------------------------------------------------------------------------------|
| Docker Hub | pyfunceble | [https://hub.docker.com/r/pyfunceble/pyfunceble](https://hub.docker.com/r/pyfunceble/pyfunceble) |
| Docker Hub | pyfunceble-dev | [https://hub.docker.com/r/pyfunceble/pyfunceble-dev](https://hub.docker.com/r/pyfunceble/pyfunceble-dev) |
## Arch Linux
Updating from the ArchLinux User Repository is straight forward.
Here is an overview of the packages and where they are hosted.
| Package | AUR Link |
|----------------|--------------------------------------------------------------------------------------------------------|
| pyfunceble | [https://aur.archlinux.org/packages/pyfunceble](https://aur.archlinux.org/packages/pyfunceble) |
| pyfunceble-dev | [https://aur.archlinux.org/packages/pyfunceble-dev](https://aur.archlinux.org/packages/pyfunceble-dev) |
### pyfunceble
#### AUR Helper
You can update the **pyfunceble** package through your favorite AUR helper:
```shell
aur-helper -Syu pyfunceble
```
#### Manually
You can update the **pyfunceble** package manually through the following:
```shell
git clone https://aur.archlinux.org/pyfunceble.git pyfunceble
cd pyfunceble
makepkg -fsri
```
### pyfunceble-dev
#### AUR Helper
You can update the **pyfunceble-dev** package through your favorite AUR helper:
```shell
aur-helper -Syu pyfunceble-dev
```
#### Manually
You can update the **pyfunceble** package manually through the following:
```shell
git clone https://aur.archlinux.org/pyfunceble-dev.git pyfunceble-dev
cd pyfunceble-dev
makepkg -fsri
```
## Git Repository
Updating from the Git Repository with `pip3` is just like a normal update of `pip`
installed package. Just add `--upgrade` to your installation command and you are good
to go.
Here is an overview of the packages and where they are hosted.
| Host | Package | Repository |
|--------|----------------|-------------------------------------------------------------------------|
| GitHub | pyfunceble | `git+https://github.com/funilrys/PyFunceble.git@master#egg=PyFunceble` |
| GitHub | pyfunceble-dev | `git+https://github.com/funilrys/PyFunceble.git@dev#egg=PyFunceble-dev` |
| GitLab | pyfunceble | `git+https://gitlab.com/funilrys/PyFunceble.git@master#egg=PyFunceble` |
| GitLab | pyfunceble-dev | `git+https://gitlab.com/funilrys/PyFunceble.git@dev#egg=PyFunceble-dev` |
!!! danger "Beware!!"
We recommend the usage of the `--user` flag as it installs the required
dependencies at the user level. The main reason behind that is to avoid
crashes or clashes between you OS package manager and `pip3`.
However, if you:
- are aware of the possible consequences
- are running PyFunceble within a CI engine or in an automated environment
you shouldn't use it.
### pyfunceble
#### GitHub
You can update the **pyfunceble** package from GitHub through `pip3`:
```shell
pip3 install --user --upgrade git+https://github.com/funilrys/PyFunceble.git@master#egg=PyFunceble
```
#### GitLab
You can update the **pyfunceble** package from GitLab through `pip3`:
```shell
pip3 install --user --upgrade git+https://gitlab.com/funilrys/PyFunceble.git@master#egg=PyFunceble
```
### pyfunceble-dev
#### GitHub
You can update the **pyfunceble-dev** package from GitHub through `pip3`:
```shell
pip3 install --user --upgrade git+https://github.com/funilrys/PyFunceble.git@dev#egg=PyFunceble-dev
```
#### GitLab
You can update the **pyfunceble-dev** package from GitLab through `pip3`:
```shell
pip3 install --user --upgrade git+https://gitlab.com/funilrys/PyFunceble.git@dev#egg=PyFunceble-dev
```
## From Source
Updating from the source with `pip3` is just like a normal update of `pip`
installed package. Just add `--upgrade` to your installation command and you are good
to go.
Here is an overview of the packages and where they are hosted.
| Host | Package | Branch | Repository |
| ------ | -------------- | -------- | -------------------------------------------------------------------------------------------------------- |
| GitHub | pyfunceble | `master` | [https://github.com/funilrys/PyFunceble/tree/master](https://github.com/funilrys/PyFunceble/tree/master) |
| GitHub | pyfunceble-dev | `dev` | [https://github.com/funilrys/PyFunceble/tree/dev](https://github.com/funilrys/PyFunceble/tree/dev) |
| GitLab | pyfunceble | `master` | [https://gitlab.com/funilrys/PyFunceble/tree/master](https://gitlab.com/funilrys/PyFunceble/tree/master) |
| GitLab | pyfunceble-dev | `dev` | [https://gitlab.com/funilrys/PyFunceble/tree/master](https://gitlab.com/funilrys/PyFunceble/tree/master) |
You can install the package from source through `pip3`:
```shell
# From Github
pip3 install --upgrade --user https://github.com/funilrys/PyFunceble/archive/{{branch}}.zip
# From GitLab
pip3 install --upgrade --user https://gitlab.com/funilrys/PyFunceble/-/archive/{{branch}}/PyFunceble-{{branch}}.zip
```
|
