README_DEV.md

Developer Guide

Setting up your work environment

Run these instructions immediately after creating your project with cookiecutter.

1. Navigate to the directory you created:

    cd nlp_course
   

2. Create a virtual environment for your development:

    conda env create -f environment.yml
    conda activate nlp_course
   

3. (optional) Install the gh app to automatically create your repository on GitHub:

    conda install gh --channel conda-forge
    gh auth login
   

4. Install your module in editable mode:

    pip install -e .
   

5. Verify that the command-line tool is working:

    nlp_course-cli --help
   

Syncing with GitHub

With the gh app

In the root folder of your newly created project:

git init
git add *
git commit -m "Initial commit"
gh repo create nlp_course --public --push --source .

Without the gh app

1. In your browser, go to GitHub and log in as tiagoft.

2. Create a new repository (empty, without an initial README, gitignore, etc.) called nlp_course (be mindful of capitalization, etc.).

3. Run the commands below in the root folder of your newly created project:

    git init
    git add *
    git commit -m "Initial commit"
    git remote add origin https://github.com/tiagoft/nlp_course.git
    git push --set-upstream origin main