v1.0 Release (#1)

## v1.0.0 - 2024-02-28

### Added

- `User()` class which contains user details
- `primary()` function to supersede `console()`
- `admins()` function to return a list of admin `User()`
- `group_member()` function to check if a user is in a group
- `fv_access()` function to check if a user has FileVault access
- `apfs_owner()` function to check if a user is an APFS volume owner
- `secure_token_status()` function to check if the user has a secure token
- `users()` function can now filter by primary group IDs
- This changelog

### Changed

- `users()` now finds users by finding users with a shell
- `users()` now returns a list of User class
- Deprecated `console()` function, use `primary()`.username for similar functionality

### Fixed

- `users()` now returns more than just "root"

Author: bryanheinz

README.md

@@ -1,21 +1,58 @@
 # macusers
-Get the macOS console username and/or a list of local non-system users.
+
+Get details on macOS user accounts.
 
 ```python
 >>> import macusers
->>> macusers.console()
+# get the logged in user details.
+>>> user = macusers.primary()
+# get the logged in user's username.
+>>> user.username
 'bryanheinz'
->>> macusers.users()
-['root', 'bryanheinz']
->>> macusers.users(False)
-['bryanheinz']
+# get logged in user's home folder as a `pathlib` object.
+>>> user.home
+PosixPath('/Users/bryanh')
+# get a list of non-system user accounts.
+>>> for user in macusers.users(False): print(user.username)
+bryanheinz
+morrismoss
+# get a list of admin accounts.
+>>> for admin in macusers.admins(False): print(admin.username)
+bryanheinz
+# check if the user has FileVault access. NOTE: requires admin.
+>>> macusers.primary().fv_access()
+True
+# check if the user is an APFS volume owner.
+>>> macusers.primary().apfs_owner()
+True
+# check if the user has a secure token.
+>>> macusers.primary().secure_token_status()
+True
 ```
 
-This module is used to get the current or last (if the system currently doesn't have any logged in users) logged in console user on macOS instead of the user running the script/program. This module can also return a list of all local non-system created users.
+This module is used to get the current or last (if the system currently doesn't have any logged in users) logged in console user on macOS instead of the user running the script/program.
+
+This module now contains the following User properties:
+
+- username        : The user's username
+- real_name       : Full name
+- uid             : The user's ID
+- gid             : Primary group ID
+- guid            : Generated user ID - used by APFS
+- home            : Home folder
+- shell           : Default shell
+- admin           : If the user is an admin
+- ssh_access      : If the user has SSH access
+- volume_owner    : If the user is an APFS volume owner
+- secure_token    : If the user has a secure token
+- created         : Epoch time when the user was created
+- password_updated: Epoch time when the user's password was last changed
+
+These properties can be accessed via `User.PROPERTY` e.g. `macusers.primary().admin`.
 
 ## Installing
 You can install macusers using pip. macusers has been tested with Python 3.7 and 3.9.
 
 ```console
-> python3 -m pip install macusers
+python3 -m pip install macusers
 ```

changelog.md

@@ -0,0 +1,34 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project attempts to adhere to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## v1.0.0 - 2024-02-28
+
+### Added
+
+- `User()` class which contains user details
+- `primary()` function to supersede `console()`
+- `admins()` function to return a list of admin `User()`
+- `group_member()` function to check if a user is in a group
+- `fv_access()` function to check if a user has FileVault access
+- `apfs_owner()` function to check if a user is an APFS volume owner
+- `secure_token_status()` function to check if the user has a secure token
+- `users()` function can now filter by primary group IDs
+- This changelog
+
+### Changed
+
+- `users()` now finds users by finding users with a shell
+- `users()` now returns a list of User class
+- Deprecated `console()` function, use `primary()`.username for similar functionality
+
+### Fixed
+
+- `users()` now returns more than just "root"
+
+## v0.0.3 - 2021-02-05
+
+Initial release