[GH-ISSUE #24] How to run from source #21

Closed
opened 2026-03-02 16:47:11 +03:00 by kerem · 5 comments
Owner

Originally created by @ryanmcfall on GitHub (Jan 25, 2023).
Original GitHub issue: https://github.com/initialcommit-com/git-sim/issues/24

I want to play around with the source code a little bit, so I've cloned the repository locally.

What do I do in order to run my local version? I don't see anything in README.md about this.

Originally created by @ryanmcfall on GitHub (Jan 25, 2023). Original GitHub issue: https://github.com/initialcommit-com/git-sim/issues/24 I want to play around with the source code a little bit, so I've cloned the repository locally. What do I do in order to run my local version? I don't see anything in `README.md` about this.
kerem closed this issue 2026-03-02 16:47:11 +03:00
Author
Owner

@initialcommit-io commented on GitHub (Jan 25, 2023):

Please check the CONTRIBUTING.md file.

Closing this while you test, if you run into any issues feel free to reopen this.

<!-- gh-comment-id:1404271625 --> @initialcommit-io commented on GitHub (Jan 25, 2023): Please check the `CONTRIBUTING.md` file. Closing this while you test, if you run into any issues feel free to reopen this.
Author
Owner

@paketb0te commented on GitHub (Jan 25, 2023):

Set up a virtual environment (e.g. pip -m venv .venv - this calls the module "venv" and creates a virtual environment in the directory .venv) and activate it (source .venv/bin/activate on Linux, see DOCS for other OSes).

Afterwards, you can run pip install -e . which will install everything in the current working directory into your virtual environment in editable mode (meaning you can work on your files and don't need to reinstall after every change).

<!-- gh-comment-id:1404273106 --> @paketb0te commented on GitHub (Jan 25, 2023): Set up a virtual environment (e.g. `pip -m venv .venv` - this calls the module "venv" and creates a virtual environment in the directory `.venv`) and activate it (`source .venv/bin/activate` on Linux, see [DOCS](https://docs.python.org/3/library/venv.html) for other OSes). Afterwards, you can run `pip install -e .` which will install everything in the current working directory into your virtual environment in editable mode (meaning you can work on your files and don't need to reinstall after every change).
Author
Owner

@ryanmcfall commented on GitHub (Jan 26, 2023):

In case someone comes across this issue, I can verify that the method suggested by @paketb0te works great. Thanks for the suggestion - I like this better than editing out the prefix from the import statements as suggested in CONTRIBUTING.md.

<!-- gh-comment-id:1405022440 --> @ryanmcfall commented on GitHub (Jan 26, 2023): In case someone comes across this issue, I can verify that the method suggested by @paketb0te works great. Thanks for the suggestion - I like this better than editing out the prefix from the `import` statements as suggested in `CONTRIBUTING.md`.
Author
Owner

@abhijitnathwani commented on GitHub (Jan 26, 2023):

Thanks for confirming @ryanmcfall. The contributing.md is now updated to reflect these changes.

<!-- gh-comment-id:1405388760 --> @abhijitnathwani commented on GitHub (Jan 26, 2023): Thanks for confirming @ryanmcfall. The `contributing.md` is now updated to reflect these changes.
Author
Owner

@initialcommit-io commented on GitHub (Jan 26, 2023):

@ryanmcfall Yes thanks for testing the various options. You're absolutely right changing the imports was not sustainable - it was just my hacky workaround.

We now have a much better option in the updated CONTRIBUTING.md.

Let us know if that works for you - it worked great for me even outside of a Virtualenv.

<!-- gh-comment-id:1405435082 --> @initialcommit-io commented on GitHub (Jan 26, 2023): @ryanmcfall Yes thanks for testing the various options. You're absolutely right changing the imports was not sustainable - it was just my hacky workaround. We now have a much better option in the updated `CONTRIBUTING.md`. Let us know if that works for you - it worked great for me even outside of a Virtualenv.
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
starred/git-sim#21
No description provided.