What does this PR do? Prints the default git message when not in a git repository: fatal: not a git repository (or any of the parent directories): .git

Why are we doing this? To solve issue #79 and to make it more user-friendly.

Testing performed

• Ran the toxcommand and also the pre-commit tests. All passed ✅
• Ran the git plan --version command which is now printing the default git error.
• Ran the gp --version which was already printing the default message.

Known issues

• Had to add sys.exit() because the git plan --version command was still printing the version even if not inside a git repository.
• I couldn't figure it out why the gp --version was not raising the RuntimeError exeception.

Current Situation

git-plan looks for the user's choice of editor through an environment variable named EDITOR and if such a variable doesn't exist, it defaults to vim.

Enhancement

git users have their choice of editor pre-configured which can be found by running git config --global core.editor. Consider using this configuration.

Reasoning

Reduces the effort for users in having to setup a new environment variable when one already exists in the git domain.

Implementation

Look up the result of git config --global core.editor and default to vim if variable is not set.

The current template is:

########### PLAN SUMMARY ##################################

########### FILES #########################################

########### END ###########################################
# Put a filename on each line
# We'll let you know if you edit any other files
###########################################################

This may be controversial, but I think that running git plan should simply trigger the help output (like git). This forces users to be explicit and type git plan list or git plan add. We could offer advice in the README on how to useful aliases for git-plan.

Initial install failed...

git-plan$ make install
Installing to .../.local/bin
install -d .../.local/bin
install -m 0755 scripts/* .../.local/bin
ln -s .../.local/bin/git-plan .../.local/bin/gp
install -d .../.local/share/git-plan
install -m 0644 assets/share/* .../.local/share/git-plan
#install -d .../.local/share/systemd/user
#install -m 0644 assets/gitplan-oracle.service .../.local/share/systemd/user
python3.8 -m venv .../.local/share/git-plan/venv
The virtual environment was not created successfully because ensurepip is not
available.  On Debian/Ubuntu systems, you need to install the python3-venv
package using the following command.

    apt-get install python3-venv

You may need to use sudo with that command.  After installing the python3-venv
package, recreate your virtual environment.

Failing command: ['.../git-plan/venv/bin/python3.8', '-Im', 'ensurepip', '--upgrade', '--default-pip']

Installed dependencies...

git-plan$ sudo apt install python3-venv

Subsequent install failed...

git-plan$ make install
...
.../.local/bin/gp': File exists 
make: *** [Makefile:29: install] Error 1

To resolve...

$ make uninstall
$ make install

Installation should be simpler/rollback if fails.

Current Situation

Maybe it works, but it's not being tested for.

Enhancement

Support python 3.10

Reasoning

Get the project back on it's feet

Implementation

Hopefully just add it to tox. Will probably also bump dependencies.

Describe the bug

Can't cut a release due to CI/CD error (https://github.com/synek/git-plan/runs/7802209163?check_suite_focus=true)

To Reproduce

Expected behavior

Screenshots

Additional context

Describe the bug

When running git-plan or gp outside of a git repository, a RuntimeError is shown with a stack trace.

To Reproduce

Steps to reproduce the behavior:

1. pip install git-plan
2. git-plan list (in a directory without a .git/ directory)

Expected behavior

A useful error message should be shown.

There is already a NotAGitRepository Exception in the stack trace, so we should just catch that in the right place and display an error message.

What does this PR do?

• Removes setup.py, Makefile, requirements_dev.txt, scripts/
• Updates pyproject.toml with full info
• Adds a new version() implementation via pkg_resources
• Adds a new CI/CD workflow for publishing to PyPi

Why are we doing this?

• A better install path

Testing performed

• Installed locally and ran various commands (incl. --version)

Known issues

Notes

Closes #72 Closes #39

When performing a fresh install, the installer may fail on python -m pip because pip is not available.

Installation completes, but the version is empty:

Installation no longer requires non-python files, and has a rollback mechanism. There are also some refactorings in the services/models, and removals of dead code.

Closes #37, for now

Current Situation

Plans are stored as JSON files in .plan/plans/

Enhancement

Run an SQLite database in .plan/ which stores plans

Reasoning

We can benefit from SQL and potentially an ORM for managing plans

Implementation

Build some sort of persistence layer which executes SQL queries against the SQLite database and returns instances of Plan. The persistence layer should implement a few methods like get_by_id, get_all, update_by_id, delete_by_id, etc..

What does this PR do?

Broadly, this PR introduces IDs/labels for plans, so that they can be referenced easily (e.g. git-plan commit --id GP-123)

Some highlights:

• changes the word "commit" to be "plan", across the codebase
• updates "plan_service" to reference plans instead of commits
• fixes a bug where plans would be filtered using the wrong variable

Why are we doing this?

• so that we can easily reference individual plans

Testing performed

Known issues

Current Situation

Output from git plan is in natural language.

Enhancement

Add --json flags to relevant commands so that output can be produced in machine-readable format.

Reasoning

This would make it easier for other tools to integrate with git plan. For example, Magit.

Implementation

Maybe the interface of the UIService could be changed to only accept some type like ResponseData. Then the UIService can render that ResponseData as either natural language or JSON output depending on whether or not --json is set.

I understand you probably won't develop this yourself, but wanted to put it on your/this community's radar anyway: support for this workflow in magit would be great for emacs users.

I'm very excited that this tool exists: a few weeks ago I was looking to scratch a similar itch. I plan on trying to see how I can integrate git plan into a dev-journal-driven git work flow (which isn't so different than a github or linear-driven flow #33, #24) - hopefully this can be designed with the ability to swap in different plan providers and templates.

Current Situation

To create a plan, you run git plan add and then type some text into your editor.

Enhancement

There should be flags like git plan add -h "headline" -b "body" that you can use to create a plan instantly.

Reasoning

This would make it easier to quickly jot down your thoughts in the form of planned commits.

Implementation

It should be a simple extension of the add command to process the two new flags.