@@ -16,7 +16,7 @@ compliant with the EBNF format of the file (yet), but it's getting there.
1616Currently, the script parses out 6 distinct line types from the file:
1717
1818- Defaults (This is only a string currently. Pieces of a Defaults setting are
19- not parsed/separated.)
19+ not parsed/separated.)
2020- Cmnd_Alias
2121- Host_Alias
2222- Runas_Alias
@@ -36,8 +36,8 @@ specification are separated out as part of the parsing:
3636
3737One caveat to add is, this module currently does not do anything with
3838` #include ` , ` #includedir ` , ` @include ` and ` @includedir ` lines, but simply
39- ignores them. You can, however, parse any included files individually if
40- needed, but any interdependencies between the files will not be resolved.
39+ ignores them. You can, however, parse any included files individually if needed,
40+ but any interdependencies between the files will not be resolved.
4141
4242## Installing
4343
@@ -50,8 +50,8 @@ pip install pysudoers
5050## Examples
5151
5252Parsing of the ` sudoers ` file is done as part of initializing the ` Sudoers `
53- object. So, you can start using the properties under ` Sudoers ` immediately.
54- The following example will print out all the different "types" from the file:
53+ object. So, you can start using the properties under ` Sudoers ` immediately. The
54+ following example will print out all the different "types" from the file:
5555
5656``` Python
5757from pysudoers import Sudoers
@@ -95,18 +95,17 @@ for rule in sobj.rules:
9595
9696## Contributing
9797
98- Pull requests to add functionality and fix bugs are always welcome. Please
99- check the CONTRIBUTING.md for specifics on contributions.
98+ Pull requests to add functionality and fix bugs are always welcome. Please check
99+ the CONTRIBUTING.md for specifics on contributions.
100100
101101### Testing
102102
103- We try to have a high level of test coverage on the code. Therefore, when
104- adding anything to the repo, tests should be written to test a new feature or
105- to test a bug fix so that there won't be a regression. This library is setup to
106- be pretty simple to build a working development environment using [ Docker] [ 3 ]
107- or [ Podman] [ 6 ] . Therefore, it is suggested that you have [ Docker] [ 3 ] or
108- [ Podman] [ 6 ] installed where you clone this repository to make development
109- easier.
103+ We try to have a high level of test coverage on the code. Therefore, when adding
104+ anything to the repo, tests should be written to test a new feature or to test a
105+ bug fix so that there won't be a regression. This library is setup to be pretty
106+ simple to build a working development environment using [ Docker] [ 3 ] or
107+ [ Podman] [ 6 ] . Therefore, it is suggested that you have [ Docker] [ 3 ] or [ Podman] [ 6 ]
108+ installed where you clone this repository to make development easier.
110109
111110To start a development environment, you should be able to just run the ` dev.sh `
112111script. This script will use the ` Containerfile ` in this repository to build a
@@ -131,11 +130,11 @@ Changelogs are now created as part of the GitHub release process.
131130## Versioning
132131
133132Updating the version is typically done using the [ bump2version] [ 5 ] tool. This
134- tool takes care of updating the version in all necessary files, updating its
135- own configuration, and making a GitHub commit and tag. We typically do version
136- bumps as part of a PR, so you don't want to have [ bump2version] [ 5 ] tag the
137- version at the same time it does the commit as commit hashes may change.
138- Therefore, to bump the version a patch level, one would run the command:
133+ tool takes care of updating the version in all necessary files, updating its own
134+ configuration, and making a GitHub commit and tag. We typically do version bumps
135+ as part of a PR, so you don't want to have [ bump2version] [ 5 ] tag the version at
136+ the same time it does the commit as commit hashes may change. Therefore, to bump
137+ the version a patch level, one would run the command:
139138
140139``` Shell
141140bump2version --verbose --no-tag patch
0 commit comments