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
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
|
%global _empty_manifest_terminate_build 0
Name: python-oschmod
Version: 0.3.12
Release: 1
Summary: Windows and Linux compatible chmod
License: Apache Software License 2.0
URL: https://github.com/yakdriver/oschmod
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/9d/64/6e522f0a1b500470ae14dcd1a4bb8f8751f5cf441e85e9fee7dfc712cb7b/oschmod-0.3.12.tar.gz
BuildArch: noarch
Requires: python3-pywin32
%description
<p>
<a href="./LICENSE" alt="License">
<img src="https://img.shields.io/github/license/YakDriver/oschmod.svg" /></a>
<a href="http://travis-ci.org/YakDriver/oschmod" alt="Build status">
<img src="https://travis-ci.org/YakDriver/oschmod.svg?branch=main" /></a>
<a href="https://pypi.python.org/pypi/oschmod" alt="Python versions">
<img src="https://img.shields.io/pypi/pyversions/oschmod.svg" /></a>
<a href="https://pypi.python.org/pypi/oschmod" alt="Version">
<img src="https://img.shields.io/pypi/v/oschmod.svg" /></a>
<img src="https://img.shields.io/endpoint.svg?url=https://gh.mergify.io/badges/YakDriver/oschmod" alt="Mergify"/>
</p>
# oschmod
***oschmod*** sets consistent file permissions across Windows, Linux and macOS.
## oschmod TL;DR
***oschmod*** brings `chmod` functionality to **Windows**, macOS, and Linux! If you're not familiar, `chmod` is a handy macOS and Linux-only tool for setting file permissions.
Prior to ***oschmod***, Windows file permissions couldn't be set in the familiar `chmod` way. Tools did not translate `chmod`-style permissions into Windows-style file permissions. Even though Python's `os.chmod()` sets read, write, and execute file permissions, on Windows, `os.chmod()` basically has no effect. Even worse, Python on Windows gives no warnings or errors. If you think you set file permissions on Windows with `os.chmod()`, you're wrong!
***oschmod*** allows you to set consistent file permissions in a consistent way across platforms.
* Read more about [oschmod](https://medium.com/@dirk.avery/securing-files-on-windows-macos-and-linux-7b2b9899992) on Medium
* For more background, have a look at the [oschmod Wiki](https://github.com/YakDriver/oschmod/wiki).
## Installation
```console
$ pip install oschmod
```
## GNU Documentation
***oschmod*** changes the file mode bits of each given file according to mode, which can be either a symbolic representation of changes to make, or an octal number representing the bit pattern for the new mode bits.
The format of a symbolic mode is `[ugoa...][+-=][perms...]` where perms is zero or more letters from the set `rwx`. Multiple symbolic modes can be given, separated by commas.
A combination of the letters `ugoa` controls which users' access to the file will be changed: the user who owns it (`u`), other users in the file's group (`g`), other users not in the file's group (`o`), or all users (`a`). If none of these are given, the effect is as if `a` were given.
*(Modified from the GNU manpage for chmod.)*
## Command line interface
***oschmod*** brings the ability to set consistent file permissions using the command line to Windows, macOS, and Linux platforms. If you are familiar with `chmod`, ***oschmod*** works similarly, albeit with fewer options.
```console
$ oschmod -h
usage: oschmod [-h] [-R] mode object
Change the mode (permissions) of a file or directory
positional arguments:
mode octal or symbolic mode of the object
object file or directory
optional arguments:
-h, --help show this help message and exit
-R apply mode recursively
```
## Command line examples
You can use symbolic (e.g., "u+rw") or octal (e.g., "600) representations of modes. Multiple mode modifications can be made in a single call by separating modifiers with commas.
### Symbolic representation examples
Symbolic representation mode modifiers have three parts:
1. **whom:** To whom does the modification apply? You can include zero or more of `[ugoa]*` where `a` is for all, `u` is for the file owner (i.e., "**u**ser"), `g` is for the file group, and `o` is for others. In other words, `ugo` is equivalent to `a`. Also, if you do not provide a "whom," ***oschmod*** assumes you mean `a` (everyone).
2. **operation:** Which operation should be applied? You must include one and only one operation, `[+-=]{1}`, per modifier (although you can have multiple modifiers). `+` adds permissions, `-` removes permissions, and `=` sets permissions regardless of previous permissions. `+` and `-` modifications often depend on the current permissions.
3. **permission:** Which permission or permissions will be affected? You can include zero or more of `[rwx]*` where `r` is for read, `w` is for write, and `x` is for execute. If you do not include a permission with `+` or `-` (e.g., `u-`), the modifier has no effect. However, if you use no permissions with `=` (e.g., `o=`), all permissions are removed.
**Example 1:** To give everyone execute permissions on a file (all of these are equivalent):
```console
$ oschmod +x <file name>
$ oschmod a+x <file name>
$ oschmod ugo+x <file name>
```
**Example 2:** To remove read, write, and execute permissions from the file group and all others (these are equivalent):
```console
$ oschmod go-rwx <file name>
$ oschmod go= <file name>
```
**Example 3:** To give the file owner read and execute permissions, and remove execute permissions from the group and all others:
```console
$ oschmod u+rx,go-x <file name>
```
**Example 4:** To give everyone all permissions, and then remove execute write from the group, and execute from all others:
```console
$ oschmod a+rwx,g-w,o-x <file name>
```
### Octal representation examples
For more about what octal representations mean, see [this article](https://medium.com/@dirk.avery/securing-files-on-windows-macos-and-linux-7b2b9899992) on Medium.
**Example 5:** To give everyone read, write, and execute permissions on a file:
```console
$ oschmod 777 <file name>
```
**Example 6:** To lock down a file to just give the file owner read, write, and execute permissions and deny all permissions to everyone else:
```console
$ oschmod 700 <file name>
```
## Python usage
You can use ***oschmod*** from Python code. Any of the command line examples above will work very similarly. For example, *Example 4* above, in Python code, would look like this:
```python
import oschmod
oschmod.set_mode("myfile", "a+rwx,g-w,o-x")
```
*Example 5* above, in Python code, could be done in two ways:
```python
import oschmod
oschmod.set_mode("myfile", "777")
oschmod.set_mode("myfile", 0o777)
```
***oschmod*** is compatible with bitwise permissions as defined in the `stat` module. To give a file's owner read, write, and execute permissions and deny the group and others any permissions (i.e., equivalent of `700`):
```python
import oschmod
import stat
oschmod.set_mode('myfile', stat.S_IRUSR | stat.S_IWUSR | stat.S_IXUSR)
```
Replacing `os.chmod()` with ***oschmod*** should usually be an easy drop-in replacement. Replacement will allow you to get consistent file permission settings on Windows, macOS, and Linux:
If this is your Python code using `os.chmod()`:
```python
import os
os.chmod('myfile1', 'u+x')
os.chmod('myfile2', 0o777)
```
The replacement using ***oschmod*** is very similar:
```python
import oschmod
oschmod.set_mode('myfile1', 'u+x')
oschmod.set_mode('myfile2', 0o777)
```
## Changelog
### 0.3.0
**Commit Delta**: [Change from 0.2.4 release](https://github.com/YakDriver/oschmod/compare/0.2.4...0.3.0)
**Released**: 2020.05.27
**Summary**:
* Adds symbolic representation for mode changes (e.g., `+x`, `u+rwx`, `ugo-x`).
### 0.2.4
**Commit Delta**: [Change from 0.2.2 release](https://github.com/YakDriver/oschmod/compare/0.2.2...0.2.4)
**Released**: 2020.04.21
**Summary**:
* Add command line interface (CLI).
### 0.2.2
**Commit Delta**: [Change from 0.2.0 release](https://github.com/YakDriver/oschmod/compare/0.2.0...0.2.2)
**Released**: 2020.04.21
**Summary**:
* Fix issue with account lookup failing with error (`No mapping between account names and security IDs was done.`).
### 0.2.0
**Commit Delta**: [Change from 0.1.5 release](https://github.com/YakDriver/oschmod/compare/0.1.5...0.2.0)
**Released**: 2020.04.20
**Summary**:
* Add recursive version of `oschmod.set_mode()`: `oschmod.set_mode_recursive()`
### 0.1.5
**Commit Delta**: [Change from 0.1.4 release](https://github.com/YakDriver/oschmod/compare/0.1.4...0.1.5)
**Released**: 2020.04.17
**Summary**:
* Create Linux version of permissions test (`oschmod.perm_test()`)
### 0.1.4
**Commit Delta**: [Change from 0.1.0 release](https://github.com/YakDriver/oschmod/compare/0.1.0...0.1.4)
**Released**: 2020.04.17
**Summary**:
* Revise Windows to keep permissions an object already has for SYSTEM/NT AUTHORITY and don't include those permissions in mode calculation.
* Fix various minor cosmetic issues.
### 0.1.0
**Commit Delta**: [Change from 0.0.0 release](https://github.com/YakDriver/oschmod/compare/0.0.0...0.1.0)
**Released**: 2020.04.15
**Summary**:
* Initial release
%package -n python3-oschmod
Summary: Windows and Linux compatible chmod
Provides: python-oschmod
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-oschmod
<p>
<a href="./LICENSE" alt="License">
<img src="https://img.shields.io/github/license/YakDriver/oschmod.svg" /></a>
<a href="http://travis-ci.org/YakDriver/oschmod" alt="Build status">
<img src="https://travis-ci.org/YakDriver/oschmod.svg?branch=main" /></a>
<a href="https://pypi.python.org/pypi/oschmod" alt="Python versions">
<img src="https://img.shields.io/pypi/pyversions/oschmod.svg" /></a>
<a href="https://pypi.python.org/pypi/oschmod" alt="Version">
<img src="https://img.shields.io/pypi/v/oschmod.svg" /></a>
<img src="https://img.shields.io/endpoint.svg?url=https://gh.mergify.io/badges/YakDriver/oschmod" alt="Mergify"/>
</p>
# oschmod
***oschmod*** sets consistent file permissions across Windows, Linux and macOS.
## oschmod TL;DR
***oschmod*** brings `chmod` functionality to **Windows**, macOS, and Linux! If you're not familiar, `chmod` is a handy macOS and Linux-only tool for setting file permissions.
Prior to ***oschmod***, Windows file permissions couldn't be set in the familiar `chmod` way. Tools did not translate `chmod`-style permissions into Windows-style file permissions. Even though Python's `os.chmod()` sets read, write, and execute file permissions, on Windows, `os.chmod()` basically has no effect. Even worse, Python on Windows gives no warnings or errors. If you think you set file permissions on Windows with `os.chmod()`, you're wrong!
***oschmod*** allows you to set consistent file permissions in a consistent way across platforms.
* Read more about [oschmod](https://medium.com/@dirk.avery/securing-files-on-windows-macos-and-linux-7b2b9899992) on Medium
* For more background, have a look at the [oschmod Wiki](https://github.com/YakDriver/oschmod/wiki).
## Installation
```console
$ pip install oschmod
```
## GNU Documentation
***oschmod*** changes the file mode bits of each given file according to mode, which can be either a symbolic representation of changes to make, or an octal number representing the bit pattern for the new mode bits.
The format of a symbolic mode is `[ugoa...][+-=][perms...]` where perms is zero or more letters from the set `rwx`. Multiple symbolic modes can be given, separated by commas.
A combination of the letters `ugoa` controls which users' access to the file will be changed: the user who owns it (`u`), other users in the file's group (`g`), other users not in the file's group (`o`), or all users (`a`). If none of these are given, the effect is as if `a` were given.
*(Modified from the GNU manpage for chmod.)*
## Command line interface
***oschmod*** brings the ability to set consistent file permissions using the command line to Windows, macOS, and Linux platforms. If you are familiar with `chmod`, ***oschmod*** works similarly, albeit with fewer options.
```console
$ oschmod -h
usage: oschmod [-h] [-R] mode object
Change the mode (permissions) of a file or directory
positional arguments:
mode octal or symbolic mode of the object
object file or directory
optional arguments:
-h, --help show this help message and exit
-R apply mode recursively
```
## Command line examples
You can use symbolic (e.g., "u+rw") or octal (e.g., "600) representations of modes. Multiple mode modifications can be made in a single call by separating modifiers with commas.
### Symbolic representation examples
Symbolic representation mode modifiers have three parts:
1. **whom:** To whom does the modification apply? You can include zero or more of `[ugoa]*` where `a` is for all, `u` is for the file owner (i.e., "**u**ser"), `g` is for the file group, and `o` is for others. In other words, `ugo` is equivalent to `a`. Also, if you do not provide a "whom," ***oschmod*** assumes you mean `a` (everyone).
2. **operation:** Which operation should be applied? You must include one and only one operation, `[+-=]{1}`, per modifier (although you can have multiple modifiers). `+` adds permissions, `-` removes permissions, and `=` sets permissions regardless of previous permissions. `+` and `-` modifications often depend on the current permissions.
3. **permission:** Which permission or permissions will be affected? You can include zero or more of `[rwx]*` where `r` is for read, `w` is for write, and `x` is for execute. If you do not include a permission with `+` or `-` (e.g., `u-`), the modifier has no effect. However, if you use no permissions with `=` (e.g., `o=`), all permissions are removed.
**Example 1:** To give everyone execute permissions on a file (all of these are equivalent):
```console
$ oschmod +x <file name>
$ oschmod a+x <file name>
$ oschmod ugo+x <file name>
```
**Example 2:** To remove read, write, and execute permissions from the file group and all others (these are equivalent):
```console
$ oschmod go-rwx <file name>
$ oschmod go= <file name>
```
**Example 3:** To give the file owner read and execute permissions, and remove execute permissions from the group and all others:
```console
$ oschmod u+rx,go-x <file name>
```
**Example 4:** To give everyone all permissions, and then remove execute write from the group, and execute from all others:
```console
$ oschmod a+rwx,g-w,o-x <file name>
```
### Octal representation examples
For more about what octal representations mean, see [this article](https://medium.com/@dirk.avery/securing-files-on-windows-macos-and-linux-7b2b9899992) on Medium.
**Example 5:** To give everyone read, write, and execute permissions on a file:
```console
$ oschmod 777 <file name>
```
**Example 6:** To lock down a file to just give the file owner read, write, and execute permissions and deny all permissions to everyone else:
```console
$ oschmod 700 <file name>
```
## Python usage
You can use ***oschmod*** from Python code. Any of the command line examples above will work very similarly. For example, *Example 4* above, in Python code, would look like this:
```python
import oschmod
oschmod.set_mode("myfile", "a+rwx,g-w,o-x")
```
*Example 5* above, in Python code, could be done in two ways:
```python
import oschmod
oschmod.set_mode("myfile", "777")
oschmod.set_mode("myfile", 0o777)
```
***oschmod*** is compatible with bitwise permissions as defined in the `stat` module. To give a file's owner read, write, and execute permissions and deny the group and others any permissions (i.e., equivalent of `700`):
```python
import oschmod
import stat
oschmod.set_mode('myfile', stat.S_IRUSR | stat.S_IWUSR | stat.S_IXUSR)
```
Replacing `os.chmod()` with ***oschmod*** should usually be an easy drop-in replacement. Replacement will allow you to get consistent file permission settings on Windows, macOS, and Linux:
If this is your Python code using `os.chmod()`:
```python
import os
os.chmod('myfile1', 'u+x')
os.chmod('myfile2', 0o777)
```
The replacement using ***oschmod*** is very similar:
```python
import oschmod
oschmod.set_mode('myfile1', 'u+x')
oschmod.set_mode('myfile2', 0o777)
```
## Changelog
### 0.3.0
**Commit Delta**: [Change from 0.2.4 release](https://github.com/YakDriver/oschmod/compare/0.2.4...0.3.0)
**Released**: 2020.05.27
**Summary**:
* Adds symbolic representation for mode changes (e.g., `+x`, `u+rwx`, `ugo-x`).
### 0.2.4
**Commit Delta**: [Change from 0.2.2 release](https://github.com/YakDriver/oschmod/compare/0.2.2...0.2.4)
**Released**: 2020.04.21
**Summary**:
* Add command line interface (CLI).
### 0.2.2
**Commit Delta**: [Change from 0.2.0 release](https://github.com/YakDriver/oschmod/compare/0.2.0...0.2.2)
**Released**: 2020.04.21
**Summary**:
* Fix issue with account lookup failing with error (`No mapping between account names and security IDs was done.`).
### 0.2.0
**Commit Delta**: [Change from 0.1.5 release](https://github.com/YakDriver/oschmod/compare/0.1.5...0.2.0)
**Released**: 2020.04.20
**Summary**:
* Add recursive version of `oschmod.set_mode()`: `oschmod.set_mode_recursive()`
### 0.1.5
**Commit Delta**: [Change from 0.1.4 release](https://github.com/YakDriver/oschmod/compare/0.1.4...0.1.5)
**Released**: 2020.04.17
**Summary**:
* Create Linux version of permissions test (`oschmod.perm_test()`)
### 0.1.4
**Commit Delta**: [Change from 0.1.0 release](https://github.com/YakDriver/oschmod/compare/0.1.0...0.1.4)
**Released**: 2020.04.17
**Summary**:
* Revise Windows to keep permissions an object already has for SYSTEM/NT AUTHORITY and don't include those permissions in mode calculation.
* Fix various minor cosmetic issues.
### 0.1.0
**Commit Delta**: [Change from 0.0.0 release](https://github.com/YakDriver/oschmod/compare/0.0.0...0.1.0)
**Released**: 2020.04.15
**Summary**:
* Initial release
%package help
Summary: Development documents and examples for oschmod
Provides: python3-oschmod-doc
%description help
<p>
<a href="./LICENSE" alt="License">
<img src="https://img.shields.io/github/license/YakDriver/oschmod.svg" /></a>
<a href="http://travis-ci.org/YakDriver/oschmod" alt="Build status">
<img src="https://travis-ci.org/YakDriver/oschmod.svg?branch=main" /></a>
<a href="https://pypi.python.org/pypi/oschmod" alt="Python versions">
<img src="https://img.shields.io/pypi/pyversions/oschmod.svg" /></a>
<a href="https://pypi.python.org/pypi/oschmod" alt="Version">
<img src="https://img.shields.io/pypi/v/oschmod.svg" /></a>
<img src="https://img.shields.io/endpoint.svg?url=https://gh.mergify.io/badges/YakDriver/oschmod" alt="Mergify"/>
</p>
# oschmod
***oschmod*** sets consistent file permissions across Windows, Linux and macOS.
## oschmod TL;DR
***oschmod*** brings `chmod` functionality to **Windows**, macOS, and Linux! If you're not familiar, `chmod` is a handy macOS and Linux-only tool for setting file permissions.
Prior to ***oschmod***, Windows file permissions couldn't be set in the familiar `chmod` way. Tools did not translate `chmod`-style permissions into Windows-style file permissions. Even though Python's `os.chmod()` sets read, write, and execute file permissions, on Windows, `os.chmod()` basically has no effect. Even worse, Python on Windows gives no warnings or errors. If you think you set file permissions on Windows with `os.chmod()`, you're wrong!
***oschmod*** allows you to set consistent file permissions in a consistent way across platforms.
* Read more about [oschmod](https://medium.com/@dirk.avery/securing-files-on-windows-macos-and-linux-7b2b9899992) on Medium
* For more background, have a look at the [oschmod Wiki](https://github.com/YakDriver/oschmod/wiki).
## Installation
```console
$ pip install oschmod
```
## GNU Documentation
***oschmod*** changes the file mode bits of each given file according to mode, which can be either a symbolic representation of changes to make, or an octal number representing the bit pattern for the new mode bits.
The format of a symbolic mode is `[ugoa...][+-=][perms...]` where perms is zero or more letters from the set `rwx`. Multiple symbolic modes can be given, separated by commas.
A combination of the letters `ugoa` controls which users' access to the file will be changed: the user who owns it (`u`), other users in the file's group (`g`), other users not in the file's group (`o`), or all users (`a`). If none of these are given, the effect is as if `a` were given.
*(Modified from the GNU manpage for chmod.)*
## Command line interface
***oschmod*** brings the ability to set consistent file permissions using the command line to Windows, macOS, and Linux platforms. If you are familiar with `chmod`, ***oschmod*** works similarly, albeit with fewer options.
```console
$ oschmod -h
usage: oschmod [-h] [-R] mode object
Change the mode (permissions) of a file or directory
positional arguments:
mode octal or symbolic mode of the object
object file or directory
optional arguments:
-h, --help show this help message and exit
-R apply mode recursively
```
## Command line examples
You can use symbolic (e.g., "u+rw") or octal (e.g., "600) representations of modes. Multiple mode modifications can be made in a single call by separating modifiers with commas.
### Symbolic representation examples
Symbolic representation mode modifiers have three parts:
1. **whom:** To whom does the modification apply? You can include zero or more of `[ugoa]*` where `a` is for all, `u` is for the file owner (i.e., "**u**ser"), `g` is for the file group, and `o` is for others. In other words, `ugo` is equivalent to `a`. Also, if you do not provide a "whom," ***oschmod*** assumes you mean `a` (everyone).
2. **operation:** Which operation should be applied? You must include one and only one operation, `[+-=]{1}`, per modifier (although you can have multiple modifiers). `+` adds permissions, `-` removes permissions, and `=` sets permissions regardless of previous permissions. `+` and `-` modifications often depend on the current permissions.
3. **permission:** Which permission or permissions will be affected? You can include zero or more of `[rwx]*` where `r` is for read, `w` is for write, and `x` is for execute. If you do not include a permission with `+` or `-` (e.g., `u-`), the modifier has no effect. However, if you use no permissions with `=` (e.g., `o=`), all permissions are removed.
**Example 1:** To give everyone execute permissions on a file (all of these are equivalent):
```console
$ oschmod +x <file name>
$ oschmod a+x <file name>
$ oschmod ugo+x <file name>
```
**Example 2:** To remove read, write, and execute permissions from the file group and all others (these are equivalent):
```console
$ oschmod go-rwx <file name>
$ oschmod go= <file name>
```
**Example 3:** To give the file owner read and execute permissions, and remove execute permissions from the group and all others:
```console
$ oschmod u+rx,go-x <file name>
```
**Example 4:** To give everyone all permissions, and then remove execute write from the group, and execute from all others:
```console
$ oschmod a+rwx,g-w,o-x <file name>
```
### Octal representation examples
For more about what octal representations mean, see [this article](https://medium.com/@dirk.avery/securing-files-on-windows-macos-and-linux-7b2b9899992) on Medium.
**Example 5:** To give everyone read, write, and execute permissions on a file:
```console
$ oschmod 777 <file name>
```
**Example 6:** To lock down a file to just give the file owner read, write, and execute permissions and deny all permissions to everyone else:
```console
$ oschmod 700 <file name>
```
## Python usage
You can use ***oschmod*** from Python code. Any of the command line examples above will work very similarly. For example, *Example 4* above, in Python code, would look like this:
```python
import oschmod
oschmod.set_mode("myfile", "a+rwx,g-w,o-x")
```
*Example 5* above, in Python code, could be done in two ways:
```python
import oschmod
oschmod.set_mode("myfile", "777")
oschmod.set_mode("myfile", 0o777)
```
***oschmod*** is compatible with bitwise permissions as defined in the `stat` module. To give a file's owner read, write, and execute permissions and deny the group and others any permissions (i.e., equivalent of `700`):
```python
import oschmod
import stat
oschmod.set_mode('myfile', stat.S_IRUSR | stat.S_IWUSR | stat.S_IXUSR)
```
Replacing `os.chmod()` with ***oschmod*** should usually be an easy drop-in replacement. Replacement will allow you to get consistent file permission settings on Windows, macOS, and Linux:
If this is your Python code using `os.chmod()`:
```python
import os
os.chmod('myfile1', 'u+x')
os.chmod('myfile2', 0o777)
```
The replacement using ***oschmod*** is very similar:
```python
import oschmod
oschmod.set_mode('myfile1', 'u+x')
oschmod.set_mode('myfile2', 0o777)
```
## Changelog
### 0.3.0
**Commit Delta**: [Change from 0.2.4 release](https://github.com/YakDriver/oschmod/compare/0.2.4...0.3.0)
**Released**: 2020.05.27
**Summary**:
* Adds symbolic representation for mode changes (e.g., `+x`, `u+rwx`, `ugo-x`).
### 0.2.4
**Commit Delta**: [Change from 0.2.2 release](https://github.com/YakDriver/oschmod/compare/0.2.2...0.2.4)
**Released**: 2020.04.21
**Summary**:
* Add command line interface (CLI).
### 0.2.2
**Commit Delta**: [Change from 0.2.0 release](https://github.com/YakDriver/oschmod/compare/0.2.0...0.2.2)
**Released**: 2020.04.21
**Summary**:
* Fix issue with account lookup failing with error (`No mapping between account names and security IDs was done.`).
### 0.2.0
**Commit Delta**: [Change from 0.1.5 release](https://github.com/YakDriver/oschmod/compare/0.1.5...0.2.0)
**Released**: 2020.04.20
**Summary**:
* Add recursive version of `oschmod.set_mode()`: `oschmod.set_mode_recursive()`
### 0.1.5
**Commit Delta**: [Change from 0.1.4 release](https://github.com/YakDriver/oschmod/compare/0.1.4...0.1.5)
**Released**: 2020.04.17
**Summary**:
* Create Linux version of permissions test (`oschmod.perm_test()`)
### 0.1.4
**Commit Delta**: [Change from 0.1.0 release](https://github.com/YakDriver/oschmod/compare/0.1.0...0.1.4)
**Released**: 2020.04.17
**Summary**:
* Revise Windows to keep permissions an object already has for SYSTEM/NT AUTHORITY and don't include those permissions in mode calculation.
* Fix various minor cosmetic issues.
### 0.1.0
**Commit Delta**: [Change from 0.0.0 release](https://github.com/YakDriver/oschmod/compare/0.0.0...0.1.0)
**Released**: 2020.04.15
**Summary**:
* Initial release
%prep
%autosetup -n oschmod-0.3.12
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-oschmod -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Tue Apr 25 2023 Python_Bot <Python_Bot@openeuler.org> - 0.3.12-1
- Package Spec generated
|