<commit_before># pyjournal

pyjournal is a commandline script written in python to create and
manage a LaTeX-based scientific journal.  The journal is distributed
(via `git`) so that we can access it from any machine we work on.  It
is commandline driven to make the barrier-to-entry for creating a
short entry minimal.  Entries are shown in date-order, and any number
of appendices can be added to the end of the journal.  The resulting
PDF journal is searchable.

* Installing:

  Simply clone the git repo and put the directory in your path.
  Alternately, if you have a `~/bin/` directory, do:

  ```
  ln -s ~/{pyjournal-path}/pyjournal.py ~/bin/
  ```

  For the simplest (and laziest) access, create an alias `pj` for
  `pyjournal.py`
  

* Starting:

  - `pyjournal.py init nickname path/ [working-path]`

    this initializes a bare git repo that will hold the journal data,
    creates the initial directory structure to hold the journal
    entries, and copies in the master journal.tex file.  It will also
    add to (or create) a `.pyjournal` file with an entry

    The master bare git repo is placed in `path`.  The working clone
    that we interact with is placed there too, unless we specify the
    optional `working-path` argument.
    
    The `git` operations that take place under the hood are:
    
      - Creating a bare repo for others to clone to/from:

        ```
        mkdir path/nickname.git
        cd path/nickname.git
        git init --bare
        ```
     
      - Creating the working directory that we will interact with:

        ```
        cd working-path/
        git clone path/nicknmae
        ```

    The contents of the `.pyjournal` are

    ```
    [nickname]
    master_repo = /path/nickname.git
    working_path = /working-path/
    ```<commit_msg>update the docs for init to be a little more clear<commit_after># pyjournal

pyjournal is a commandline script written in python to create and
manage a LaTeX-based scientific journal.  The journal is distributed
(via `git`) so that we can access it from any machine we work on.  It
is commandline driven to make the barrier-to-entry for creating a
short entry minimal.  Entries are shown in date-order, and any number
of appendices can be added to the end of the journal.  The resulting
PDF journal is searchable.

* Installing:

  Simply clone the git repo and put the directory in your path.
  Alternately, if you have a `~/bin/` directory, do:

  ```
  ln -s ~/{pyjournal-path}/pyjournal.py ~/bin/
  ```

  For the simplest (and laziest) access, create an alias `pj` for
  `pyjournal.py`
  

* Starting:

  - `pyjournal.py init nickname path/ [working-path]`

    this initializes a bare git repo that will hold the journal data,
    creates the initial directory structure to hold the journal
    entries, and copies in the master journal.tex file.  It will also
    add to (or create) a `.pyjournal` file with an entry

    `path/` should be an existing directory.  The journal master repo
	will be created as a subdirectory under `path/` as a bare git
	repo.  The working clone that we interact with is placed there
	too, unless we specify the optional `working-path` argument.
    
    The `git` operations that take place under the hood are:
    
      - Creating a bare repo for others to clone to/from:

        ```
        mkdir path/nickname.git
        cd path/nickname.git
        git init --bare
        ```
     
      - Creating the working directory that we will interact with:

        ```
        cd working-path/
        git clone path/nicknmae
        ```

    The contents of the `.pyjournal` are

    ```
    [nickname]
    master_repo = /path/nickname.git
    working_path = /working-path/
    ```
{'fraction_non_alphanumeric': 0.07062298603651987, 'fraction_numerical': 0.0, 'mean_word_length': 2.673570019723866, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4240835', 'n_tokens_mistral': 1064, 'n_tokens_neox': 1024, 'n_words': 500}