Skip to content

Setup The Project (◍•ᴗ•◍) #34

@Rational-Idiot

Description

@Rational-Idiot

To finally get to beating Linus Torvalds by making a better VCS, we must setup out project first :D

To understand the dir structure

.
├── .git
├── .gitignore                     #=> Mandatory to have in the same way the proj has configured
├── .venv                          #=> Must be activated by the following commands 
├── build                          #=> Must be added to the .gitignore
├── CONTRIBUTING.md        
├── Contributors                         
├── ding.egg-info                  #=> Must be added to the .gitignore 
├── README.md
├── setup.py                       #=> Use the exact same one that we have provided 
└── src                            #=> The dir where all the code will live

The .gitignore will be as follows

build/
ding.egg-info/
Contributors/
__pycache__/

It will be in the repo itself


First you must activate your venv to use python

python3 -m venv .venv

Activate the environment

Operating System / Shell Activation Command
Linux (bash/zsh) source .venv/bin/activate
macOS (bash/zsh) source .venv/bin/activate
Windows – PowerShell ..venv\Scripts\Activate.ps1
Windows – CMD ..venv\Scripts\activate.bat
Windows – Git Bash source .venv/Scripts/activate

Or this can be done from your editor as well, like VsCode, Sublime etc.


The setup.py will also be in the repo, to run the project, follow the following the step

  • Sync your fork
  • pull your own fork to your local repo
  • chmod +x setup.py
  • ./setup.py build
  • pip install -e .

Then you can just use ding in the command line to run the program, the entry point for the program lives inside of cli.py main()
You have to just do this once and then you use ding in your command line even after editing the source code

Now, we can get started on actually building the project !

Task: For the "completion" of this pr

  • Do the complete setup as mentioned above
  • Edit cli.py and make it print knock knock, who's there kinda joke but with ding dong instead
    For example
def main() : 
    print("Ding Dong, who's there \nThe IRS \nOh Shit")

And add a screenshot of the program running in the issue description

Image

Check out #resources on discord in the DING section for guides and tutorials, also don't hesitate to ping me there too ~

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions