Updates to getting started documentation#156

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
drewoldag merged 2 commits into from
Apr 3, 2023
Merged

Updates to getting started documentation #156

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8e27c1d
Added assumptions section, moved info about pipx to "practices". Rewo…
drewoldag Apr 3, 2023
454b004
Merge branch 'main' into issue/136/add-assumptions-section
drewoldag Apr 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions docs/index.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,16 @@
LINCC Frameworks Python Project Template
===============================================================================

This project template codifies LINCC-Framework's best practices for python code organization, testing, documentation, and automation.
It is meant to help new python projects get started quickly, letting the user focus on writing code.
The template takes care of the minutia of directory structures, tool configurations, and automated testing until the user is ready to take over.
This project template codifies LINCC Framework's best practices for python code
organization, testing, documentation, and automation.
It is meant to help python projects get started quickly and allow the user
to focus on writing code.

`Copier <https://copier.readthedocs.io/en/latest/>`_ is required to use this template.
Copier is an open source tool that hydrates projects from templates and natively supports updating projects as the original template matures.
It's really neat!
We think it's really neat, and we hope you do to!

.. toctree::
:maxdepth: 1
:caption: Getting Started
:caption: Using the Template

source/overview
source/new_project
Expand All@@ -28,6 +27,7 @@ It's really neat!
practices/code_coverage
practices/git-lfs
practices/linting
practices/pipx
practices/precommit
practices/pypi
practices/sphinx
1 change: 1 addition & 0 deletions docs/practices/overview.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ Practices
* :doc:`ci_testing`
* :doc:`code_coverage`
* :doc:`linting`
* :doc:`pipx`
* :doc:`precommit`
* :doc:`pypi`
* :doc:`sphinx`
Expand Down
47 changes: 47 additions & 0 deletions docs/practices/pipx.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
pipx
=========

``pipx`` is a tool to enable installation of end-user applications written
in Python.
The main difference from ``pip`` is that any application installed with ``pip``
is only executable from an environment that ``pip`` installs it into, while
``pipx`` makes the tool executable from any environment.

This means that ``pipx`` can install Python command line tools (such as Copier)
so that they can be used from any virtual environment.
Additionally, ``pipx`` installs these tools and their dependencies into
isolated locations.
Doing so avoids dependency version conflicts and makes uninstalling packages
easy and safe.


How we use it
-------------

We use ``pipx`` to install Copier (the technology that powers our template) as
a command line tool, so that we can call ``copier`` from any virtual environment.
Beyond that, we don't use ``pipx`` for anything else in the template.

In the :doc:`Getting Started <../source/overview>` section, we assume the use of ``pipx``. But you can use
``conda`` or ``pip`` if you'd rather have ``copier`` installed in a specific
environment. We have not yet documented the differences to the getting started
workflow that this would require.

How to install ``pipx``
-----------------------

There are a few different ways to install ``pipx`` depending on your operating
system.
Using ``conda`` to install ``pipx`` is probably easiest.
However, if you don't have ``conda`` already, take a look at the
`pipx documentation <https://pypa.github.io/pipx/>`_ to find the
installation process that is most straightforward for you system.

An example installation of ``pipx`` might look like this.

.. code-block:: bash

>> conda install -c conda-forge pipx
>> pipx ensurepath

Pro tip: Don't forget the ``pipx ensurepath`` to finalize the installation!
82 changes: 36 additions & 46 deletions docs/source/overview.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,43 @@
Get Started
Getting Started
===============================================================================

This project template codifies LINCC-Framework's best practices for python code organization, testing, documentation, and automation.
It is meant to help new python projects get started quickly, letting the user focus on writing code.
The template takes care of the minutia of directory structures, tool configurations, and automated testing until the user is ready to take over.
This project template codifies LINCC Framework's best practices for python code
organization, testing, documentation, and automation.
It is meant to help python projects get started quickly and allow the user
to focus on writing code.

`Copier <https://copier.readthedocs.io/en/latest/>`_ is required to use this template.
Copier is an open source tool that hydrates projects from templates and natively supports updating projects as the original template matures.
It's really neat!
We built this tool with a few assumptions in mind.
The following are **not** considered requirements to use the template.
However, some of the included tooling may not work as expected if your project
doesn't follow these guidelines.

1. Your project is mostly Python based.
2. GitHub will be used as a remote repository.
3. Your remote repository will be publicly available.

We have seen the template used successfully in projects that don't adhere to
these guidelines. But if you meet these guidelines, you'll be guaranteed to get
the full benefit of the template.

.. _prerequisites:

Prerequisites
-------------------------------------------------------------------------------
These prerequisites for Copier are defined `here <https://copier.readthedocs.io/en/latest/#installation>`_
but summarized below.
--------------

To use our template you'll need to install
`Copier <https://copier.readthedocs.io/en/latest/>`_.
Copier is an open source tool that hydrates projects from templates and
natively supports updating projects as the original template matures.
It's really neat!

1. Python > 3.7
2. Git > 2.27
3. Pipx (recommended - pip and conda work too, but require a different work flow)
.. important::
Copier has two requirements and one recommended tool:

.. tip::
You check your prerequisite versions as shown below
1. Python > 3.7 (required)
2. Git > 2.27 (required)
3. pipx (recommended - more info about pipx :doc:`here<../practices/pipx>`)

You can check your requirements like so:

.. code-block:: bash

Expand All@@ -34,39 +50,13 @@ but summarized below.
>> which pipx
/usr/bin/pipx

.. note::
``pipx`` is a tool to enable installation of end-user applications written in Python. The main difference
from ``pip`` is that any tool (such as copier in the next section) installed with pip is only executable from an
environment that ``pip`` installs it into, while ``pipx`` makes the tool executable from any environment.

While we will assume the use of ``pipx`` in this documentation, be aware that you are able to use
``conda`` or ``pip`` if you'd rather have it installed just in one environment.

Please be aware that ``pipx ensurepath`` should be run after installing ``pipx``, as shown below

.. code-block:: bash

>> conda install -c conda-forge pipx
>> pipx ensurepath

For more information about ``pipx`` see the `documentation <https://pypa.github.io/pipx/>`_.


Install Copier
-------------------------------------------------------------------------------

Given that you have all the prerequisites satisfied, go ahead and install Copier.
Given that your system satisfies the requirements, go ahead and install Copier.

.. code-block:: bash

>> pipx install copier

Now you can either create a new project, or use the template configuration in an existing project.
Choose your next adventure...


Next Steps
-------------------------------------------------------------------------------

* :doc:`new_project`
* :doc:`existing_project`
Now choose your next adventure...
-------------------------------------
* :doc:`Start a new project<new_project>`
* :doc:`Upgrade an existing project<existing_project>`
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Updates to getting started documentation#156

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

drewoldag
merged 2 commits into

from

Apr 3, 2023
 Merged


Updates to getting started documentation
#156
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
8e27c1d

Added assumptions section, moved info about pipx to "practices". Rewo…


drewoldag Apr 3, 2023
454b004

Merge branch 'main' into issue/136/add-assumptions-section


drewoldag Apr 3, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


14 changes: 7 additions & 7 deletions
docs/index.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,16 @@
LINCC Frameworks Python Project Template
===============================================================================

This project template codifies LINCC-Framework's best practices for python code organization, testing, documentation, and automation.
It is meant to help new python projects get started quickly, letting the user focus on writing code.
The template takes care of the minutia of directory structures, tool configurations, and automated testing until the user is ready to take over.
This project template codifies LINCC Framework's best practices for python code 
organization, testing, documentation, and automation.
It is meant to help python projects get started quickly and allow the user 
to focus on writing code. 

`Copier <https://copier.readthedocs.io/en/latest/>`_ is required to use this template.
Copier is an open source tool that hydrates projects from templates and natively supports updating projects as the original template matures.
It's really neat!
We think it's really neat, and we hope you do to!

.. toctree::
 :maxdepth: 1
 :caption: Getting Started
 :caption: Using the Template

 source/overview
 source/new_project
Expand All@@ -28,6 +27,7 @@ It's really neat!
 practices/code_coverage
 practices/git-lfs
 practices/linting
 practices/pipx
 practices/precommit
 practices/pypi
 practices/sphinx

1 change: 1 addition & 0 deletions
docs/practices/overview.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ Practices
* :doc:`ci_testing`
* :doc:`code_coverage`
* :doc:`linting`
* :doc:`pipx`
* :doc:`precommit`
* :doc:`pypi`
* :doc:`sphinx`
Expand Down

47 changes: 47 additions & 0 deletions
docs/practices/pipx.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
pipx
=========

``pipx`` is a tool to enable installation of end-user applications written 
in Python.
The main difference from ``pip`` is that any application installed with ``pip`` 
is only executable from an environment that ``pip`` installs it into, while 
``pipx`` makes the tool executable from any environment.

This means that ``pipx`` can install Python command line tools (such as Copier) 
so that they can be used from any virtual environment. 
Additionally, ``pipx`` installs these tools and their dependencies into 
isolated locations. 
Doing so avoids dependency version conflicts and makes uninstalling packages 
easy and safe.


How we use it
-------------

We use ``pipx`` to install Copier (the technology that powers our template) as 
a command line tool, so that we can call ``copier`` from any virtual environment.
Beyond that, we don't use ``pipx`` for anything else in the template.

In the :doc:`Getting Started <../source/overview>` section, we assume the use of ``pipx``. But you can use 
``conda`` or ``pip`` if you'd rather have ``copier`` installed in a specific 
environment. We have not yet documented the differences to the getting started 
workflow that this would require.

How to install ``pipx``
-----------------------

There are a few different ways to install ``pipx`` depending on your operating 
system. 
Using ``conda`` to install ``pipx`` is probably easiest.
However, if you don't have ``conda`` already, take a look at the 
`pipx documentation <https://pypa.github.io/pipx/>`_ to find the 
installation process that is most straightforward for you system.

An example installation of ``pipx`` might look like this. 

.. code-block:: bash

 >> conda install -c conda-forge pipx
 >> pipx ensurepath

Pro tip: Don't forget the ``pipx ensurepath`` to finalize the installation!

82 changes: 36 additions & 46 deletions
docs/source/overview.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,27 +1,43 @@
Get Started
Getting Started
===============================================================================

This project template codifies LINCC-Framework's best practices for python code organization, testing, documentation, and automation.
It is meant to help new python projects get started quickly, letting the user focus on writing code.
The template takes care of the minutia of directory structures, tool configurations, and automated testing until the user is ready to take over.
This project template codifies LINCC Framework's best practices for python code 
organization, testing, documentation, and automation.
It is meant to help python projects get started quickly and allow the user 
to focus on writing code. 

`Copier <https://copier.readthedocs.io/en/latest/>`_ is required to use this template. 
Copier is an open source tool that hydrates projects from templates and natively supports updating projects as the original template matures. 
It's really neat!
We built this tool with a few assumptions in mind.
The following are **not** considered requirements to use the template.
However, some of the included tooling may not work as expected if your project 
doesn't follow these guidelines.

1. Your project is mostly Python based.
2. GitHub will be used as a remote repository.
3. Your remote repository will be publicly available.

We have seen the template used successfully in projects that don't adhere to 
these guidelines. But if you meet these guidelines, you'll be guaranteed to get 
the full benefit of the template.

.. _prerequisites:

Prerequisites
-------------------------------------------------------------------------------
These prerequisites for Copier are defined `here <https://copier.readthedocs.io/en/latest/#installation>`_ 
but summarized below.
--------------

To use our template you'll need to install 
`Copier <https://copier.readthedocs.io/en/latest/>`_. 
Copier is an open source tool that hydrates projects from templates and 
natively supports updating projects as the original template matures. 
It's really neat!

1. Python > 3.7
2. Git > 2.27
3. Pipx (recommended - pip and conda work too, but require a different work flow)
.. important::
 Copier has two requirements and one recommended tool:

.. tip:: 
 You check your prerequisite versions as shown below
 1. Python > 3.7 (required)
 2. Git > 2.27 (required)
 3. pipx (recommended - more info about pipx :doc:`here<../practices/pipx>`)

 You can check your requirements like so:

 .. code-block:: bash

Expand All@@ -34,39 +50,13 @@ but summarized below.
 >> which pipx
 /usr/bin/pipx

.. note::
 ``pipx`` is a tool to enable installation of end-user applications written in Python. The main difference
 from ``pip`` is that any tool (such as copier in the next section) installed with pip is only executable from an
 environment that ``pip`` installs it into, while ``pipx`` makes the tool executable from any environment.

 While we will assume the use of ``pipx`` in this documentation, be aware that you are able to use 
 ``conda`` or ``pip`` if you'd rather have it installed just in one environment.

 Please be aware that ``pipx ensurepath`` should be run after installing ``pipx``, as shown below

 .. code-block:: bash

 >> conda install -c conda-forge pipx
 >> pipx ensurepath

 For more information about ``pipx`` see the `documentation <https://pypa.github.io/pipx/>`_.


Install Copier
-------------------------------------------------------------------------------

Given that you have all the prerequisites satisfied, go ahead and install Copier.
Given that your system satisfies the requirements, go ahead and install Copier.

.. code-block:: bash

 >> pipx install copier

Now you can either create a new project, or use the template configuration in an existing project.
Choose your next adventure...


Next Steps
-------------------------------------------------------------------------------

* :doc:`new_project`
* :doc:`existing_project`
Now choose your next adventure...
-------------------------------------
* :doc:`Start a new project<new_project>`
* :doc:`Upgrade an existing project<existing_project>`

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Updates to getting started documentation#156

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

drewoldag
merged 2 commits into

from

Apr 3, 2023
 Merged


Updates to getting started documentation
#156
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
8e27c1d

Added assumptions section, moved info about pipx to "practices". Rewo…


drewoldag Apr 3, 2023
454b004

Merge branch 'main' into issue/136/add-assumptions-section


drewoldag Apr 3, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


14 changes: 7 additions & 7 deletions
docs/index.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,16 @@
LINCC Frameworks Python Project Template
===============================================================================

This project template codifies LINCC-Framework's best practices for python code organization, testing, documentation, and automation.
It is meant to help new python projects get started quickly, letting the user focus on writing code.
The template takes care of the minutia of directory structures, tool configurations, and automated testing until the user is ready to take over.
This project template codifies LINCC Framework's best practices for python code 
organization, testing, documentation, and automation.
It is meant to help python projects get started quickly and allow the user 
to focus on writing code. 

`Copier <https://copier.readthedocs.io/en/latest/>`_ is required to use this template.
Copier is an open source tool that hydrates projects from templates and natively supports updating projects as the original template matures.
It's really neat!
We think it's really neat, and we hope you do to!

.. toctree::
 :maxdepth: 1
 :caption: Getting Started
 :caption: Using the Template

 source/overview
 source/new_project
Expand All@@ -28,6 +27,7 @@ It's really neat!
 practices/code_coverage
 practices/git-lfs
 practices/linting
 practices/pipx
 practices/precommit
 practices/pypi
 practices/sphinx

1 change: 1 addition & 0 deletions
docs/practices/overview.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ Practices
* :doc:`ci_testing`
* :doc:`code_coverage`
* :doc:`linting`
* :doc:`pipx`
* :doc:`precommit`
* :doc:`pypi`
* :doc:`sphinx`
Expand Down

47 changes: 47 additions & 0 deletions
docs/practices/pipx.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
pipx
=========

``pipx`` is a tool to enable installation of end-user applications written 
in Python.
The main difference from ``pip`` is that any application installed with ``pip`` 
is only executable from an environment that ``pip`` installs it into, while 
``pipx`` makes the tool executable from any environment.

This means that ``pipx`` can install Python command line tools (such as Copier) 
so that they can be used from any virtual environment. 
Additionally, ``pipx`` installs these tools and their dependencies into 
isolated locations. 
Doing so avoids dependency version conflicts and makes uninstalling packages 
easy and safe.


How we use it
-------------

We use ``pipx`` to install Copier (the technology that powers our template) as 
a command line tool, so that we can call ``copier`` from any virtual environment.
Beyond that, we don't use ``pipx`` for anything else in the template.

In the :doc:`Getting Started <../source/overview>` section, we assume the use of ``pipx``. But you can use 
``conda`` or ``pip`` if you'd rather have ``copier`` installed in a specific 
environment. We have not yet documented the differences to the getting started 
workflow that this would require.

How to install ``pipx``
-----------------------

There are a few different ways to install ``pipx`` depending on your operating 
system. 
Using ``conda`` to install ``pipx`` is probably easiest.
However, if you don't have ``conda`` already, take a look at the 
`pipx documentation <https://pypa.github.io/pipx/>`_ to find the 
installation process that is most straightforward for you system.

An example installation of ``pipx`` might look like this. 

.. code-block:: bash

 >> conda install -c conda-forge pipx
 >> pipx ensurepath

Pro tip: Don't forget the ``pipx ensurepath`` to finalize the installation!

82 changes: 36 additions & 46 deletions
docs/source/overview.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,27 +1,43 @@
Get Started
Getting Started
===============================================================================

This project template codifies LINCC-Framework's best practices for python code organization, testing, documentation, and automation.
It is meant to help new python projects get started quickly, letting the user focus on writing code.
The template takes care of the minutia of directory structures, tool configurations, and automated testing until the user is ready to take over.
This project template codifies LINCC Framework's best practices for python code 
organization, testing, documentation, and automation.
It is meant to help python projects get started quickly and allow the user 
to focus on writing code. 

`Copier <https://copier.readthedocs.io/en/latest/>`_ is required to use this template. 
Copier is an open source tool that hydrates projects from templates and natively supports updating projects as the original template matures. 
It's really neat!
We built this tool with a few assumptions in mind.
The following are **not** considered requirements to use the template.
However, some of the included tooling may not work as expected if your project 
doesn't follow these guidelines.

1. Your project is mostly Python based.
2. GitHub will be used as a remote repository.
3. Your remote repository will be publicly available.

We have seen the template used successfully in projects that don't adhere to 
these guidelines. But if you meet these guidelines, you'll be guaranteed to get 
the full benefit of the template.

.. _prerequisites:

Prerequisites
-------------------------------------------------------------------------------
These prerequisites for Copier are defined `here <https://copier.readthedocs.io/en/latest/#installation>`_ 
but summarized below.
--------------

To use our template you'll need to install 
`Copier <https://copier.readthedocs.io/en/latest/>`_. 
Copier is an open source tool that hydrates projects from templates and 
natively supports updating projects as the original template matures. 
It's really neat!

1. Python > 3.7
2. Git > 2.27
3. Pipx (recommended - pip and conda work too, but require a different work flow)
.. important::
 Copier has two requirements and one recommended tool:

.. tip:: 
 You check your prerequisite versions as shown below
 1. Python > 3.7 (required)
 2. Git > 2.27 (required)
 3. pipx (recommended - more info about pipx :doc:`here<../practices/pipx>`)

 You can check your requirements like so:

 .. code-block:: bash

Expand All@@ -34,39 +50,13 @@ but summarized below.
 >> which pipx
 /usr/bin/pipx

.. note::
 ``pipx`` is a tool to enable installation of end-user applications written in Python. The main difference
 from ``pip`` is that any tool (such as copier in the next section) installed with pip is only executable from an
 environment that ``pip`` installs it into, while ``pipx`` makes the tool executable from any environment.

 While we will assume the use of ``pipx`` in this documentation, be aware that you are able to use 
 ``conda`` or ``pip`` if you'd rather have it installed just in one environment.

 Please be aware that ``pipx ensurepath`` should be run after installing ``pipx``, as shown below

 .. code-block:: bash

 >> conda install -c conda-forge pipx
 >> pipx ensurepath

 For more information about ``pipx`` see the `documentation <https://pypa.github.io/pipx/>`_.


Install Copier
-------------------------------------------------------------------------------

Given that you have all the prerequisites satisfied, go ahead and install Copier.
Given that your system satisfies the requirements, go ahead and install Copier.

.. code-block:: bash

 >> pipx install copier

Now you can either create a new project, or use the template configuration in an existing project.
Choose your next adventure...


Next Steps
-------------------------------------------------------------------------------

* :doc:`new_project`
* :doc:`existing_project`
Now choose your next adventure...
-------------------------------------
* :doc:`Start a new project<new_project>`
* :doc:`Upgrade an existing project<existing_project>`

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Updates to getting started documentation#156

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

drewoldag
merged 2 commits into

from

Apr 3, 2023
 Merged


Updates to getting started documentation
#156
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
8e27c1d

Added assumptions section, moved info about pipx to "practices". Rewo…


drewoldag Apr 3, 2023
454b004

Merge branch 'main' into issue/136/add-assumptions-section


drewoldag Apr 3, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


14 changes: 7 additions & 7 deletions
docs/index.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,16 @@
LINCC Frameworks Python Project Template
===============================================================================

This project template codifies LINCC-Framework's best practices for python code organization, testing, documentation, and automation.
It is meant to help new python projects get started quickly, letting the user focus on writing code.
The template takes care of the minutia of directory structures, tool configurations, and automated testing until the user is ready to take over.
This project template codifies LINCC Framework's best practices for python code 
organization, testing, documentation, and automation.
It is meant to help python projects get started quickly and allow the user 
to focus on writing code. 

`Copier <https://copier.readthedocs.io/en/latest/>`_ is required to use this template.
Copier is an open source tool that hydrates projects from templates and natively supports updating projects as the original template matures.
It's really neat!
We think it's really neat, and we hope you do to!

.. toctree::
 :maxdepth: 1
 :caption: Getting Started
 :caption: Using the Template

 source/overview
 source/new_project
Expand All@@ -28,6 +27,7 @@ It's really neat!
 practices/code_coverage
 practices/git-lfs
 practices/linting
 practices/pipx
 practices/precommit
 practices/pypi
 practices/sphinx

1 change: 1 addition & 0 deletions
docs/practices/overview.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ Practices
* :doc:`ci_testing`
* :doc:`code_coverage`
* :doc:`linting`
* :doc:`pipx`
* :doc:`precommit`
* :doc:`pypi`
* :doc:`sphinx`
Expand Down

47 changes: 47 additions & 0 deletions
docs/practices/pipx.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
pipx
=========

``pipx`` is a tool to enable installation of end-user applications written 
in Python.
The main difference from ``pip`` is that any application installed with ``pip`` 
is only executable from an environment that ``pip`` installs it into, while 
``pipx`` makes the tool executable from any environment.

This means that ``pipx`` can install Python command line tools (such as Copier) 
so that they can be used from any virtual environment. 
Additionally, ``pipx`` installs these tools and their dependencies into 
isolated locations. 
Doing so avoids dependency version conflicts and makes uninstalling packages 
easy and safe.


How we use it
-------------

We use ``pipx`` to install Copier (the technology that powers our template) as 
a command line tool, so that we can call ``copier`` from any virtual environment.
Beyond that, we don't use ``pipx`` for anything else in the template.

In the :doc:`Getting Started <../source/overview>` section, we assume the use of ``pipx``. But you can use 
``conda`` or ``pip`` if you'd rather have ``copier`` installed in a specific 
environment. We have not yet documented the differences to the getting started 
workflow that this would require.

How to install ``pipx``
-----------------------

There are a few different ways to install ``pipx`` depending on your operating 
system. 
Using ``conda`` to install ``pipx`` is probably easiest.
However, if you don't have ``conda`` already, take a look at the 
`pipx documentation <https://pypa.github.io/pipx/>`_ to find the 
installation process that is most straightforward for you system.

An example installation of ``pipx`` might look like this. 

.. code-block:: bash

 >> conda install -c conda-forge pipx
 >> pipx ensurepath

Pro tip: Don't forget the ``pipx ensurepath`` to finalize the installation!

82 changes: 36 additions & 46 deletions
docs/source/overview.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,27 +1,43 @@
Get Started
Getting Started
===============================================================================

This project template codifies LINCC-Framework's best practices for python code organization, testing, documentation, and automation.
It is meant to help new python projects get started quickly, letting the user focus on writing code.
The template takes care of the minutia of directory structures, tool configurations, and automated testing until the user is ready to take over.
This project template codifies LINCC Framework's best practices for python code 
organization, testing, documentation, and automation.
It is meant to help python projects get started quickly and allow the user 
to focus on writing code. 

`Copier <https://copier.readthedocs.io/en/latest/>`_ is required to use this template. 
Copier is an open source tool that hydrates projects from templates and natively supports updating projects as the original template matures. 
It's really neat!
We built this tool with a few assumptions in mind.
The following are **not** considered requirements to use the template.
However, some of the included tooling may not work as expected if your project 
doesn't follow these guidelines.

1. Your project is mostly Python based.
2. GitHub will be used as a remote repository.
3. Your remote repository will be publicly available.

We have seen the template used successfully in projects that don't adhere to 
these guidelines. But if you meet these guidelines, you'll be guaranteed to get 
the full benefit of the template.

.. _prerequisites:

Prerequisites
-------------------------------------------------------------------------------
These prerequisites for Copier are defined `here <https://copier.readthedocs.io/en/latest/#installation>`_ 
but summarized below.
--------------

To use our template you'll need to install 
`Copier <https://copier.readthedocs.io/en/latest/>`_. 
Copier is an open source tool that hydrates projects from templates and 
natively supports updating projects as the original template matures. 
It's really neat!

1. Python > 3.7
2. Git > 2.27
3. Pipx (recommended - pip and conda work too, but require a different work flow)
.. important::
 Copier has two requirements and one recommended tool:

.. tip:: 
 You check your prerequisite versions as shown below
 1. Python > 3.7 (required)
 2. Git > 2.27 (required)
 3. pipx (recommended - more info about pipx :doc:`here<../practices/pipx>`)

 You can check your requirements like so:

 .. code-block:: bash

Expand All@@ -34,39 +50,13 @@ but summarized below.
 >> which pipx
 /usr/bin/pipx

.. note::
 ``pipx`` is a tool to enable installation of end-user applications written in Python. The main difference
 from ``pip`` is that any tool (such as copier in the next section) installed with pip is only executable from an
 environment that ``pip`` installs it into, while ``pipx`` makes the tool executable from any environment.

 While we will assume the use of ``pipx`` in this documentation, be aware that you are able to use 
 ``conda`` or ``pip`` if you'd rather have it installed just in one environment.

 Please be aware that ``pipx ensurepath`` should be run after installing ``pipx``, as shown below

 .. code-block:: bash

 >> conda install -c conda-forge pipx
 >> pipx ensurepath

 For more information about ``pipx`` see the `documentation <https://pypa.github.io/pipx/>`_.


Install Copier
-------------------------------------------------------------------------------

Given that you have all the prerequisites satisfied, go ahead and install Copier.
Given that your system satisfies the requirements, go ahead and install Copier.

.. code-block:: bash

 >> pipx install copier

Now you can either create a new project, or use the template configuration in an existing project.
Choose your next adventure...


Next Steps
-------------------------------------------------------------------------------

* :doc:`new_project`
* :doc:`existing_project`
Now choose your next adventure...
-------------------------------------
* :doc:`Start a new project<new_project>`
* :doc:`Upgrade an existing project<existing_project>`

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Updates to getting started documentation#156

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

drewoldag
merged 2 commits into

from

Apr 3, 2023
 Merged


Updates to getting started documentation
#156
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
8e27c1d

Added assumptions section, moved info about pipx to "practices". Rewo…


drewoldag Apr 3, 2023
454b004

Merge branch 'main' into issue/136/add-assumptions-section


drewoldag Apr 3, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


14 changes: 7 additions & 7 deletions
docs/index.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,16 @@
LINCC Frameworks Python Project Template
===============================================================================

This project template codifies LINCC-Framework's best practices for python code organization, testing, documentation, and automation.
It is meant to help new python projects get started quickly, letting the user focus on writing code.
The template takes care of the minutia of directory structures, tool configurations, and automated testing until the user is ready to take over.
This project template codifies LINCC Framework's best practices for python code 
organization, testing, documentation, and automation.
It is meant to help python projects get started quickly and allow the user 
to focus on writing code. 

`Copier <https://copier.readthedocs.io/en/latest/>`_ is required to use this template.
Copier is an open source tool that hydrates projects from templates and natively supports updating projects as the original template matures.
It's really neat!
We think it's really neat, and we hope you do to!

.. toctree::
 :maxdepth: 1
 :caption: Getting Started
 :caption: Using the Template

 source/overview
 source/new_project
Expand All@@ -28,6 +27,7 @@ It's really neat!
 practices/code_coverage
 practices/git-lfs
 practices/linting
 practices/pipx
 practices/precommit
 practices/pypi
 practices/sphinx

1 change: 1 addition & 0 deletions
docs/practices/overview.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ Practices
* :doc:`ci_testing`
* :doc:`code_coverage`
* :doc:`linting`
* :doc:`pipx`
* :doc:`precommit`
* :doc:`pypi`
* :doc:`sphinx`
Expand Down

47 changes: 47 additions & 0 deletions
docs/practices/pipx.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
pipx
=========

``pipx`` is a tool to enable installation of end-user applications written 
in Python.
The main difference from ``pip`` is that any application installed with ``pip`` 
is only executable from an environment that ``pip`` installs it into, while 
``pipx`` makes the tool executable from any environment.

This means that ``pipx`` can install Python command line tools (such as Copier) 
so that they can be used from any virtual environment. 
Additionally, ``pipx`` installs these tools and their dependencies into 
isolated locations. 
Doing so avoids dependency version conflicts and makes uninstalling packages 
easy and safe.


How we use it
-------------

We use ``pipx`` to install Copier (the technology that powers our template) as 
a command line tool, so that we can call ``copier`` from any virtual environment.
Beyond that, we don't use ``pipx`` for anything else in the template.

In the :doc:`Getting Started <../source/overview>` section, we assume the use of ``pipx``. But you can use 
``conda`` or ``pip`` if you'd rather have ``copier`` installed in a specific 
environment. We have not yet documented the differences to the getting started 
workflow that this would require.

How to install ``pipx``
-----------------------

There are a few different ways to install ``pipx`` depending on your operating 
system. 
Using ``conda`` to install ``pipx`` is probably easiest.
However, if you don't have ``conda`` already, take a look at the 
`pipx documentation <https://pypa.github.io/pipx/>`_ to find the 
installation process that is most straightforward for you system.

An example installation of ``pipx`` might look like this. 

.. code-block:: bash

 >> conda install -c conda-forge pipx
 >> pipx ensurepath

Pro tip: Don't forget the ``pipx ensurepath`` to finalize the installation!

82 changes: 36 additions & 46 deletions
docs/source/overview.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,27 +1,43 @@
Get Started
Getting Started
===============================================================================

This project template codifies LINCC-Framework's best practices for python code organization, testing, documentation, and automation.
It is meant to help new python projects get started quickly, letting the user focus on writing code.
The template takes care of the minutia of directory structures, tool configurations, and automated testing until the user is ready to take over.
This project template codifies LINCC Framework's best practices for python code 
organization, testing, documentation, and automation.
It is meant to help python projects get started quickly and allow the user 
to focus on writing code. 

`Copier <https://copier.readthedocs.io/en/latest/>`_ is required to use this template. 
Copier is an open source tool that hydrates projects from templates and natively supports updating projects as the original template matures. 
It's really neat!
We built this tool with a few assumptions in mind.
The following are **not** considered requirements to use the template.
However, some of the included tooling may not work as expected if your project 
doesn't follow these guidelines.

1. Your project is mostly Python based.
2. GitHub will be used as a remote repository.
3. Your remote repository will be publicly available.

We have seen the template used successfully in projects that don't adhere to 
these guidelines. But if you meet these guidelines, you'll be guaranteed to get 
the full benefit of the template.

.. _prerequisites:

Prerequisites
-------------------------------------------------------------------------------
These prerequisites for Copier are defined `here <https://copier.readthedocs.io/en/latest/#installation>`_ 
but summarized below.
--------------

To use our template you'll need to install 
`Copier <https://copier.readthedocs.io/en/latest/>`_. 
Copier is an open source tool that hydrates projects from templates and 
natively supports updating projects as the original template matures. 
It's really neat!

1. Python > 3.7
2. Git > 2.27
3. Pipx (recommended - pip and conda work too, but require a different work flow)
.. important::
 Copier has two requirements and one recommended tool:

.. tip:: 
 You check your prerequisite versions as shown below
 1. Python > 3.7 (required)
 2. Git > 2.27 (required)
 3. pipx (recommended - more info about pipx :doc:`here<../practices/pipx>`)

 You can check your requirements like so:

 .. code-block:: bash

Expand All@@ -34,39 +50,13 @@ but summarized below.
 >> which pipx
 /usr/bin/pipx

.. note::
 ``pipx`` is a tool to enable installation of end-user applications written in Python. The main difference
 from ``pip`` is that any tool (such as copier in the next section) installed with pip is only executable from an
 environment that ``pip`` installs it into, while ``pipx`` makes the tool executable from any environment.

 While we will assume the use of ``pipx`` in this documentation, be aware that you are able to use 
 ``conda`` or ``pip`` if you'd rather have it installed just in one environment.

 Please be aware that ``pipx ensurepath`` should be run after installing ``pipx``, as shown below

 .. code-block:: bash

 >> conda install -c conda-forge pipx
 >> pipx ensurepath

 For more information about ``pipx`` see the `documentation <https://pypa.github.io/pipx/>`_.


Install Copier
-------------------------------------------------------------------------------

Given that you have all the prerequisites satisfied, go ahead and install Copier.
Given that your system satisfies the requirements, go ahead and install Copier.

.. code-block:: bash

 >> pipx install copier

Now you can either create a new project, or use the template configuration in an existing project.
Choose your next adventure...


Next Steps
-------------------------------------------------------------------------------

* :doc:`new_project`
* :doc:`existing_project`
Now choose your next adventure...
-------------------------------------
* :doc:`Start a new project<new_project>`
* :doc:`Upgrade an existing project<existing_project>`

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Updates to getting started documentation#156

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

drewoldag
merged 2 commits into

from

Apr 3, 2023
 Merged


Updates to getting started documentation
#156
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
8e27c1d

Added assumptions section, moved info about pipx to "practices". Rewo…


drewoldag Apr 3, 2023
454b004

Merge branch 'main' into issue/136/add-assumptions-section


drewoldag Apr 3, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


14 changes: 7 additions & 7 deletions
docs/index.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,16 @@
LINCC Frameworks Python Project Template
===============================================================================

This project template codifies LINCC-Framework's best practices for python code organization, testing, documentation, and automation.
It is meant to help new python projects get started quickly, letting the user focus on writing code.
The template takes care of the minutia of directory structures, tool configurations, and automated testing until the user is ready to take over.
This project template codifies LINCC Framework's best practices for python code 
organization, testing, documentation, and automation.
It is meant to help python projects get started quickly and allow the user 
to focus on writing code. 

`Copier <https://copier.readthedocs.io/en/latest/>`_ is required to use this template.
Copier is an open source tool that hydrates projects from templates and natively supports updating projects as the original template matures.
It's really neat!
We think it's really neat, and we hope you do to!

.. toctree::
 :maxdepth: 1
 :caption: Getting Started
 :caption: Using the Template

 source/overview
 source/new_project
Expand All@@ -28,6 +27,7 @@ It's really neat!
 practices/code_coverage
 practices/git-lfs
 practices/linting
 practices/pipx
 practices/precommit
 practices/pypi
 practices/sphinx

1 change: 1 addition & 0 deletions
docs/practices/overview.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ Practices
* :doc:`ci_testing`
* :doc:`code_coverage`
* :doc:`linting`
* :doc:`pipx`
* :doc:`precommit`
* :doc:`pypi`
* :doc:`sphinx`
Expand Down

47 changes: 47 additions & 0 deletions
docs/practices/pipx.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
pipx
=========

``pipx`` is a tool to enable installation of end-user applications written 
in Python.
The main difference from ``pip`` is that any application installed with ``pip`` 
is only executable from an environment that ``pip`` installs it into, while 
``pipx`` makes the tool executable from any environment.

This means that ``pipx`` can install Python command line tools (such as Copier) 
so that they can be used from any virtual environment. 
Additionally, ``pipx`` installs these tools and their dependencies into 
isolated locations. 
Doing so avoids dependency version conflicts and makes uninstalling packages 
easy and safe.


How we use it
-------------

We use ``pipx`` to install Copier (the technology that powers our template) as 
a command line tool, so that we can call ``copier`` from any virtual environment.
Beyond that, we don't use ``pipx`` for anything else in the template.

In the :doc:`Getting Started <../source/overview>` section, we assume the use of ``pipx``. But you can use 
``conda`` or ``pip`` if you'd rather have ``copier`` installed in a specific 
environment. We have not yet documented the differences to the getting started 
workflow that this would require.

How to install ``pipx``
-----------------------

There are a few different ways to install ``pipx`` depending on your operating 
system. 
Using ``conda`` to install ``pipx`` is probably easiest.
However, if you don't have ``conda`` already, take a look at the 
`pipx documentation <https://pypa.github.io/pipx/>`_ to find the 
installation process that is most straightforward for you system.

An example installation of ``pipx`` might look like this. 

.. code-block:: bash

 >> conda install -c conda-forge pipx
 >> pipx ensurepath

Pro tip: Don't forget the ``pipx ensurepath`` to finalize the installation!

82 changes: 36 additions & 46 deletions
docs/source/overview.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,27 +1,43 @@
Get Started
Getting Started
===============================================================================

This project template codifies LINCC-Framework's best practices for python code organization, testing, documentation, and automation.
It is meant to help new python projects get started quickly, letting the user focus on writing code.
The template takes care of the minutia of directory structures, tool configurations, and automated testing until the user is ready to take over.
This project template codifies LINCC Framework's best practices for python code 
organization, testing, documentation, and automation.
It is meant to help python projects get started quickly and allow the user 
to focus on writing code. 

`Copier <https://copier.readthedocs.io/en/latest/>`_ is required to use this template. 
Copier is an open source tool that hydrates projects from templates and natively supports updating projects as the original template matures. 
It's really neat!
We built this tool with a few assumptions in mind.
The following are **not** considered requirements to use the template.
However, some of the included tooling may not work as expected if your project 
doesn't follow these guidelines.

1. Your project is mostly Python based.
2. GitHub will be used as a remote repository.
3. Your remote repository will be publicly available.

We have seen the template used successfully in projects that don't adhere to 
these guidelines. But if you meet these guidelines, you'll be guaranteed to get 
the full benefit of the template.

.. _prerequisites:

Prerequisites
-------------------------------------------------------------------------------
These prerequisites for Copier are defined `here <https://copier.readthedocs.io/en/latest/#installation>`_ 
but summarized below.
--------------

To use our template you'll need to install 
`Copier <https://copier.readthedocs.io/en/latest/>`_. 
Copier is an open source tool that hydrates projects from templates and 
natively supports updating projects as the original template matures. 
It's really neat!

1. Python > 3.7
2. Git > 2.27
3. Pipx (recommended - pip and conda work too, but require a different work flow)
.. important::
 Copier has two requirements and one recommended tool:

.. tip:: 
 You check your prerequisite versions as shown below
 1. Python > 3.7 (required)
 2. Git > 2.27 (required)
 3. pipx (recommended - more info about pipx :doc:`here<../practices/pipx>`)

 You can check your requirements like so:

 .. code-block:: bash

Expand All@@ -34,39 +50,13 @@ but summarized below.
 >> which pipx
 /usr/bin/pipx

.. note::
 ``pipx`` is a tool to enable installation of end-user applications written in Python. The main difference
 from ``pip`` is that any tool (such as copier in the next section) installed with pip is only executable from an
 environment that ``pip`` installs it into, while ``pipx`` makes the tool executable from any environment.

 While we will assume the use of ``pipx`` in this documentation, be aware that you are able to use 
 ``conda`` or ``pip`` if you'd rather have it installed just in one environment.

 Please be aware that ``pipx ensurepath`` should be run after installing ``pipx``, as shown below

 .. code-block:: bash

 >> conda install -c conda-forge pipx
 >> pipx ensurepath

 For more information about ``pipx`` see the `documentation <https://pypa.github.io/pipx/>`_.


Install Copier
-------------------------------------------------------------------------------

Given that you have all the prerequisites satisfied, go ahead and install Copier.
Given that your system satisfies the requirements, go ahead and install Copier.

.. code-block:: bash

 >> pipx install copier

Now you can either create a new project, or use the template configuration in an existing project.
Choose your next adventure...


Next Steps
-------------------------------------------------------------------------------

* :doc:`new_project`
* :doc:`existing_project`
Now choose your next adventure...
-------------------------------------
* :doc:`Start a new project<new_project>`
* :doc:`Upgrade an existing project<existing_project>`

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Updates to getting started documentation#156

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

drewoldag
merged 2 commits into

from

Apr 3, 2023
 Merged


Updates to getting started documentation
#156
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
8e27c1d

Added assumptions section, moved info about pipx to "practices". Rewo…


drewoldag Apr 3, 2023
454b004

Merge branch 'main' into issue/136/add-assumptions-section


drewoldag Apr 3, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


14 changes: 7 additions & 7 deletions
docs/index.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,16 @@
LINCC Frameworks Python Project Template
===============================================================================

This project template codifies LINCC-Framework's best practices for python code organization, testing, documentation, and automation.
It is meant to help new python projects get started quickly, letting the user focus on writing code.
The template takes care of the minutia of directory structures, tool configurations, and automated testing until the user is ready to take over.
This project template codifies LINCC Framework's best practices for python code 
organization, testing, documentation, and automation.
It is meant to help python projects get started quickly and allow the user 
to focus on writing code. 

`Copier <https://copier.readthedocs.io/en/latest/>`_ is required to use this template.
Copier is an open source tool that hydrates projects from templates and natively supports updating projects as the original template matures.
It's really neat!
We think it's really neat, and we hope you do to!

.. toctree::
 :maxdepth: 1
 :caption: Getting Started
 :caption: Using the Template

 source/overview
 source/new_project
Expand All@@ -28,6 +27,7 @@ It's really neat!
 practices/code_coverage
 practices/git-lfs
 practices/linting
 practices/pipx
 practices/precommit
 practices/pypi
 practices/sphinx

1 change: 1 addition & 0 deletions
docs/practices/overview.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ Practices
* :doc:`ci_testing`
* :doc:`code_coverage`
* :doc:`linting`
* :doc:`pipx`
* :doc:`precommit`
* :doc:`pypi`
* :doc:`sphinx`
Expand Down

47 changes: 47 additions & 0 deletions
docs/practices/pipx.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
pipx
=========

``pipx`` is a tool to enable installation of end-user applications written 
in Python.
The main difference from ``pip`` is that any application installed with ``pip`` 
is only executable from an environment that ``pip`` installs it into, while 
``pipx`` makes the tool executable from any environment.

This means that ``pipx`` can install Python command line tools (such as Copier) 
so that they can be used from any virtual environment. 
Additionally, ``pipx`` installs these tools and their dependencies into 
isolated locations. 
Doing so avoids dependency version conflicts and makes uninstalling packages 
easy and safe.


How we use it
-------------

We use ``pipx`` to install Copier (the technology that powers our template) as 
a command line tool, so that we can call ``copier`` from any virtual environment.
Beyond that, we don't use ``pipx`` for anything else in the template.

In the :doc:`Getting Started <../source/overview>` section, we assume the use of ``pipx``. But you can use 
``conda`` or ``pip`` if you'd rather have ``copier`` installed in a specific 
environment. We have not yet documented the differences to the getting started 
workflow that this would require.

How to install ``pipx``
-----------------------

There are a few different ways to install ``pipx`` depending on your operating 
system. 
Using ``conda`` to install ``pipx`` is probably easiest.
However, if you don't have ``conda`` already, take a look at the 
`pipx documentation <https://pypa.github.io/pipx/>`_ to find the 
installation process that is most straightforward for you system.

An example installation of ``pipx`` might look like this. 

.. code-block:: bash

 >> conda install -c conda-forge pipx
 >> pipx ensurepath

Pro tip: Don't forget the ``pipx ensurepath`` to finalize the installation!

82 changes: 36 additions & 46 deletions
docs/source/overview.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,27 +1,43 @@
Get Started
Getting Started
===============================================================================

This project template codifies LINCC-Framework's best practices for python code organization, testing, documentation, and automation.
It is meant to help new python projects get started quickly, letting the user focus on writing code.
The template takes care of the minutia of directory structures, tool configurations, and automated testing until the user is ready to take over.
This project template codifies LINCC Framework's best practices for python code 
organization, testing, documentation, and automation.
It is meant to help python projects get started quickly and allow the user 
to focus on writing code. 

`Copier <https://copier.readthedocs.io/en/latest/>`_ is required to use this template. 
Copier is an open source tool that hydrates projects from templates and natively supports updating projects as the original template matures. 
It's really neat!
We built this tool with a few assumptions in mind.
The following are **not** considered requirements to use the template.
However, some of the included tooling may not work as expected if your project 
doesn't follow these guidelines.

1. Your project is mostly Python based.
2. GitHub will be used as a remote repository.
3. Your remote repository will be publicly available.

We have seen the template used successfully in projects that don't adhere to 
these guidelines. But if you meet these guidelines, you'll be guaranteed to get 
the full benefit of the template.

.. _prerequisites:

Prerequisites
-------------------------------------------------------------------------------
These prerequisites for Copier are defined `here <https://copier.readthedocs.io/en/latest/#installation>`_ 
but summarized below.
--------------

To use our template you'll need to install 
`Copier <https://copier.readthedocs.io/en/latest/>`_. 
Copier is an open source tool that hydrates projects from templates and 
natively supports updating projects as the original template matures. 
It's really neat!

1. Python > 3.7
2. Git > 2.27
3. Pipx (recommended - pip and conda work too, but require a different work flow)
.. important::
 Copier has two requirements and one recommended tool:

.. tip:: 
 You check your prerequisite versions as shown below
 1. Python > 3.7 (required)
 2. Git > 2.27 (required)
 3. pipx (recommended - more info about pipx :doc:`here<../practices/pipx>`)

 You can check your requirements like so:

 .. code-block:: bash

Expand All@@ -34,39 +50,13 @@ but summarized below.
 >> which pipx
 /usr/bin/pipx

.. note::
 ``pipx`` is a tool to enable installation of end-user applications written in Python. The main difference
 from ``pip`` is that any tool (such as copier in the next section) installed with pip is only executable from an
 environment that ``pip`` installs it into, while ``pipx`` makes the tool executable from any environment.

 While we will assume the use of ``pipx`` in this documentation, be aware that you are able to use 
 ``conda`` or ``pip`` if you'd rather have it installed just in one environment.

 Please be aware that ``pipx ensurepath`` should be run after installing ``pipx``, as shown below

 .. code-block:: bash

 >> conda install -c conda-forge pipx
 >> pipx ensurepath

 For more information about ``pipx`` see the `documentation <https://pypa.github.io/pipx/>`_.


Install Copier
-------------------------------------------------------------------------------

Given that you have all the prerequisites satisfied, go ahead and install Copier.
Given that your system satisfies the requirements, go ahead and install Copier.

.. code-block:: bash

 >> pipx install copier

Now you can either create a new project, or use the template configuration in an existing project.
Choose your next adventure...


Next Steps
-------------------------------------------------------------------------------

* :doc:`new_project`
* :doc:`existing_project`
Now choose your next adventure...
-------------------------------------
* :doc:`Start a new project<new_project>`
* :doc:`Upgrade an existing project<existing_project>`

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Updates to getting started documentation#156

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

drewoldag
merged 2 commits into

from

Apr 3, 2023
 Merged


Updates to getting started documentation
#156
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
8e27c1d

Added assumptions section, moved info about pipx to "practices". Rewo…


drewoldag Apr 3, 2023
454b004

Merge branch 'main' into issue/136/add-assumptions-section


drewoldag Apr 3, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


14 changes: 7 additions & 7 deletions
docs/index.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,16 @@
LINCC Frameworks Python Project Template
===============================================================================

This project template codifies LINCC-Framework's best practices for python code organization, testing, documentation, and automation.
It is meant to help new python projects get started quickly, letting the user focus on writing code.
The template takes care of the minutia of directory structures, tool configurations, and automated testing until the user is ready to take over.
This project template codifies LINCC Framework's best practices for python code 
organization, testing, documentation, and automation.
It is meant to help python projects get started quickly and allow the user 
to focus on writing code. 

`Copier <https://copier.readthedocs.io/en/latest/>`_ is required to use this template.
Copier is an open source tool that hydrates projects from templates and natively supports updating projects as the original template matures.
It's really neat!
We think it's really neat, and we hope you do to!

.. toctree::
 :maxdepth: 1
 :caption: Getting Started
 :caption: Using the Template

 source/overview
 source/new_project
Expand All@@ -28,6 +27,7 @@ It's really neat!
 practices/code_coverage
 practices/git-lfs
 practices/linting
 practices/pipx
 practices/precommit
 practices/pypi
 practices/sphinx

1 change: 1 addition & 0 deletions
docs/practices/overview.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ Practices
* :doc:`ci_testing`
* :doc:`code_coverage`
* :doc:`linting`
* :doc:`pipx`
* :doc:`precommit`
* :doc:`pypi`
* :doc:`sphinx`
Expand Down

47 changes: 47 additions & 0 deletions
docs/practices/pipx.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
pipx
=========

``pipx`` is a tool to enable installation of end-user applications written 
in Python.
The main difference from ``pip`` is that any application installed with ``pip`` 
is only executable from an environment that ``pip`` installs it into, while 
``pipx`` makes the tool executable from any environment.

This means that ``pipx`` can install Python command line tools (such as Copier) 
so that they can be used from any virtual environment. 
Additionally, ``pipx`` installs these tools and their dependencies into 
isolated locations. 
Doing so avoids dependency version conflicts and makes uninstalling packages 
easy and safe.


How we use it
-------------

We use ``pipx`` to install Copier (the technology that powers our template) as 
a command line tool, so that we can call ``copier`` from any virtual environment.
Beyond that, we don't use ``pipx`` for anything else in the template.

In the :doc:`Getting Started <../source/overview>` section, we assume the use of ``pipx``. But you can use 
``conda`` or ``pip`` if you'd rather have ``copier`` installed in a specific 
environment. We have not yet documented the differences to the getting started 
workflow that this would require.

How to install ``pipx``
-----------------------

There are a few different ways to install ``pipx`` depending on your operating 
system. 
Using ``conda`` to install ``pipx`` is probably easiest.
However, if you don't have ``conda`` already, take a look at the 
`pipx documentation <https://pypa.github.io/pipx/>`_ to find the 
installation process that is most straightforward for you system.

An example installation of ``pipx`` might look like this. 

.. code-block:: bash

 >> conda install -c conda-forge pipx
 >> pipx ensurepath

Pro tip: Don't forget the ``pipx ensurepath`` to finalize the installation!

82 changes: 36 additions & 46 deletions
docs/source/overview.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,27 +1,43 @@
Get Started
Getting Started
===============================================================================

This project template codifies LINCC-Framework's best practices for python code organization, testing, documentation, and automation.
It is meant to help new python projects get started quickly, letting the user focus on writing code.
The template takes care of the minutia of directory structures, tool configurations, and automated testing until the user is ready to take over.
This project template codifies LINCC Framework's best practices for python code 
organization, testing, documentation, and automation.
It is meant to help python projects get started quickly and allow the user 
to focus on writing code. 

`Copier <https://copier.readthedocs.io/en/latest/>`_ is required to use this template. 
Copier is an open source tool that hydrates projects from templates and natively supports updating projects as the original template matures. 
It's really neat!
We built this tool with a few assumptions in mind.
The following are **not** considered requirements to use the template.
However, some of the included tooling may not work as expected if your project 
doesn't follow these guidelines.

1. Your project is mostly Python based.
2. GitHub will be used as a remote repository.
3. Your remote repository will be publicly available.

We have seen the template used successfully in projects that don't adhere to 
these guidelines. But if you meet these guidelines, you'll be guaranteed to get 
the full benefit of the template.

.. _prerequisites:

Prerequisites
-------------------------------------------------------------------------------
These prerequisites for Copier are defined `here <https://copier.readthedocs.io/en/latest/#installation>`_ 
but summarized below.
--------------

To use our template you'll need to install 
`Copier <https://copier.readthedocs.io/en/latest/>`_. 
Copier is an open source tool that hydrates projects from templates and 
natively supports updating projects as the original template matures. 
It's really neat!

1. Python > 3.7
2. Git > 2.27
3. Pipx (recommended - pip and conda work too, but require a different work flow)
.. important::
 Copier has two requirements and one recommended tool:

.. tip:: 
 You check your prerequisite versions as shown below
 1. Python > 3.7 (required)
 2. Git > 2.27 (required)
 3. pipx (recommended - more info about pipx :doc:`here<../practices/pipx>`)

 You can check your requirements like so:

 .. code-block:: bash

Expand All@@ -34,39 +50,13 @@ but summarized below.
 >> which pipx
 /usr/bin/pipx

.. note::
 ``pipx`` is a tool to enable installation of end-user applications written in Python. The main difference
 from ``pip`` is that any tool (such as copier in the next section) installed with pip is only executable from an
 environment that ``pip`` installs it into, while ``pipx`` makes the tool executable from any environment.

 While we will assume the use of ``pipx`` in this documentation, be aware that you are able to use 
 ``conda`` or ``pip`` if you'd rather have it installed just in one environment.

 Please be aware that ``pipx ensurepath`` should be run after installing ``pipx``, as shown below

 .. code-block:: bash

 >> conda install -c conda-forge pipx
 >> pipx ensurepath

 For more information about ``pipx`` see the `documentation <https://pypa.github.io/pipx/>`_.


Install Copier
-------------------------------------------------------------------------------

Given that you have all the prerequisites satisfied, go ahead and install Copier.
Given that your system satisfies the requirements, go ahead and install Copier.

.. code-block:: bash

 >> pipx install copier

Now you can either create a new project, or use the template configuration in an existing project.
Choose your next adventure...


Next Steps
-------------------------------------------------------------------------------

* :doc:`new_project`
* :doc:`existing_project`
Now choose your next adventure...
-------------------------------------
* :doc:`Start a new project<new_project>`
* :doc:`Upgrade an existing project<existing_project>`