gstore

Bug Fixes

• Correct furo version definition in setup.py.

Breaking Changes

• Drop Python 3.7 support.

Trivial/Internal Changes

• Bumped beautifulsoup4 from 4.11.0 to 4.11.1.
• Bumped check-manifest from 0.48 to 0.49.
• Bumped coverage from 6.3.2 to 7.2.1.
• Bumped furo from 2020.12 to 2022.12.7.
• Bumped gitpython from 3.1.17 to 3.1.31.
• Bumped pygithub from 1.57 to 1.58.0.
• Bumped pylint from 2.13.5 to 2.16.2.
• Bumped pytest from 7.1.1 to 7.2.1.
• Bumped sphinx from 4.3.2 to 6.1.3.

Features

• Introduced ability to specify the maximum number of concurrent processes to use when syncing.

Improvements

• Reformat log entries to provide logs in a bit more readable format as well as process id (PID).
• Changed additional groups of dependencies declared in setup.py so that develop is superset now for testing and docs.
• Remove dependencies from develop group which are not necessary for developing the package.
• Used single requirements.txt file to declare project dependencies. Additional dependencies from develop, testing and docs groups lives now in setup.py or tox.ini.

Bug Fixes

• Added missed files to the package contents.
• Don't include tests package in wheel. Previously pip install gstore used to install a top-level package tests. This was fixed.
• Fixed package description.

Features

• The gstore.env module was introduced to provide a convenient way to work with environment variables used by various functions within Gstore.

• Added the following functions within gstore.env:

  • lookup_token() - lookup a personal access token in environment variables,
  • get_host() - get GitHub API hostname from environment variable,
  • get_target() - get base target to sync repos from environment variable.

Breaking Changes

• Moved gstore.Client.TOKEN_NAMES to gstore.env.TOKEN_NAMES.
• Moved gstore.args.get_token_from_env() to ``gstore.env.lookup_token()`.

Improvements

• Improved git.GitCommandError message formatting for more accurate logging.
• The program now correctly handle Control-C keyboard event and gracefully terminates.
• Gstore will exit with a status of one when its is called without any argument and there are not enough environment variables for normal operation.
• Calling program with an invalid token and without --org option no longer leads to abnormal program termination.

Trivial/Internal Changes

• gstore.Client.__init__() will raise now gstore.client.ValidationError when no token is provided.
• gstore.Client.resolve_orgs() will raise now gstore.client.InvalidCredentialsError when provided token is invalid.

Improvements

• Gstore will exit with a status of one if there are critical errors during synchronization.
• Gstore will handle situations with invalid API token or organization name.

Improved Documentation

• Move all the documentation to readthedocs.

Bug Fixes

• Fix args.get_token_from_env() to properly get a token from environment variables or None if variables are not set.

Trivial/Internal Changes

• Client.__init__(), as well as Client.resolve_orgs() will raise now gstore.exceptions.InvalidCredentialsError in case of incorrect credentials usage.
• gstore.models.Repository now holds gstore.models.Organization.
• Starting with v0.3.1 tests will be included in the PyPI package.

• Python < 3.7 is no longer supported.
• Added -o as a short form of --org argument.
• Added ability to limit sync to the specified repositories using -r, --repo option.
• Improved logging and error reporting.
• Improved local repo handling by checking the directory contents.
• Corrected log level on --quiet mode.
• Changed the way to get repositories from specific organizations. From now, to get repositories from specific organizations, list each of them on the command line using the argument --org.
• Fixed invalid local repo handling.

• Show help message and exit when Gstore is called without any argument and there are not enough environment variables for normal operation.
• Added ability to specify host for Github Enterprise.

• Handling situations when the target for sync is a regular file or readonly.
• Added -V, --version arguments to print program's version information.
• Added -dumpversion argument to print the version of the program and don't do anything else.
• Added -q, --quiet arguments to silence any informational messages except error ones

• The GitHub username is no longer required upon obtaining organizations list.
• Provided ability to pass authentication token for github.com API requests via environment variables.
• Added -v argument support to enable verbose mode.
• Changed the way to communicate with GitHub API. requests library no longer used thanks to PyGithub.

• Added better logging subsystem.
• Bump GitPython version to fix a crash for users with gitpython>=3.0.0, <3.0.6. For more see: https://github.com/gitpython-developers/GitPython/issues/983 .

• Renamed GHS_DIR environment variable to GSTORE_DIR.
• Renamed package name from ghs to gstore to avoid collision with the existing package with the same name.

• Added ability to use GHS_DIR as a sync base directory.
• Added ability to omit target directory and use current working directory.
• Added ability to fetch objects and refs from an existent repository.

• Renamed package name from ghsync to ghs to avoid collision with the existing package with the same name.

Initial Release.