🐍
NxPy: Nx Python plugin
This project was generated using Nx.
The nx-python plugin allows users to create a basic python application using nx commands. To add the plugin to your project, just follow these steps:
Getting started
Create a Nx Workspace
Before installing the nx-python plugin, it is required to have a pre-configured Nx Workspace . If you don't, then proceed to create a new one executing the following command:
npx create-nx-workspace python-workspace --preset=empty --cli=nx --nx-cloud true
cd python-workspace
Install the nx-python plugin
yarn add -D @nx-python/nx-python
Adding an application to our workspace
To create a new python application based on this plugin, please execute the following command:
nx g @nx-python/nx-python:app
Note: Replace
with the name of your new application
Usage
After creating the
application using the nx-python plugin. We can execute the build, lint, test and serve nx commands on this new application. Output will be stored on dist/
directory.
Building the app
The build command is going to compile all the python files inside
directory, using the py_compile native module.
nx build
More information here: py_compile
Linting the application
Unfortunately Python doesn't have a native linting module(yet!). nx-python uses the Flake8 module to lint your application. It is required that you install this module beforehand. More info here: Flake8
pip install Flake8
After that you can perform the lint process with:
nx lint
Serving the application
This is going to execute the main file in your python application.
nx serve
Testing your application
The test command is going to execute all the test units inside your python app. You can add new test unit files if you want, but there are two requirements that you must meet:
- The filename must include the prefix
test - Because we are using the native
unittestpython module to make our tests, you are going to create the tests based on this approach. More info here: unittest
To test your python app, execute the command:
nx test
Contributing
MIT License
Made with
2 Sep 21, 2022
687 Jan 4, 2023
12 Dec 16, 2022
4 Sep 4, 2021
1 Oct 21, 2021
1 Apr 9, 2022
16 Sep 25, 2022
3 Jan 10, 2022
3 Dec 30, 2021
1 Feb 03, 2022
26 Dec 12, 2022
51 Nov 29, 2022
8 Dec 22, 2021
1 Oct 12, 2021
1 Dec 07, 2022
2 Nov 23, 2021
0 Jan 29, 2022
39 Oct 20, 2022
303 Jan 03, 2023
19 Jul 20, 2022
1 Oct 31, 2021
38 May 26, 2022
1 Jan 16, 2022
13 Nov 08, 2022
1 Nov 23, 2021
17.1k Jan 04, 2023
83 Dec 26, 2022
19 Jan 21, 2022
6 Jan 03, 2023