normfmt 0.0.14
Norminette v3 formatter
License: MIT License
Requires Python: >=3.7
Keywords: 42,norminette,norm,formatter

<div id="top"></div>

# [WIP] normfmt
[Norminatte v3](https://github.com/42School/norminette) formatter

<details>
  <summary>Table of Contents</summary>
  <ol>
    <li> <a href="#Demo">Demo</a> </li>
    <li> <a href="#Installation">Installation</a> </li>
    <li> <a href="#Usage">Usage</a> </li>
    <li> <a href="#Roadmap">Roadmap</a> </li>
    <li> <a href="#Contributing">Contributing</a> </li>
    <li> <a href="#License">License</a> </li>
    <li> <a href="#Acknowledgment">Acknowledgment</a> </li>
    <li> <a href="#References">References</a> </li>
  </ol>
</details>



## Demo
WIP

<p align="right">(<a href="#top">back to top</a>)</p>



## Prerequisites
Requires brew, python3.7+ (3.7, 3.8, 3.9) and clang-format12.0.1+ (12.0.1, 13.0.0)

### In Cluster or Guacamole
```shell
# Install brew
mkdir -p /goinfre/$USER/homebrew && curl -L https://github.com/Homebrew/brew/tarball/master | tar xz --strip 1 -C /goinfre/$USER/homebrew
echo 'PATH="/goinfre/$USER/homebrew/bin:$PATH"' >> $HOME/.zshrc

# Install python3
brew install python@3.9

# Install clang-format
brew install clang-format
```



## Installation
### Using pip
```shell
python3 -m pip install --upgrade pip setuptools
python3 -m pip install normfmt
python3 -m pip install --user normfmt
```

To upgrade an existing install, use
```shell
python3 -m pip install --upgrade normfmt
```

### Manual
```shell
git clone git@github.com:solareenlo/normfmt.git
cd normfmt
pip3 install -e .
```

<p align="right">(<a href="#top">back to top</a>)</p>



## Usage
### Manual
```shell
normfmt main.c
```

### Vim
WIP

<p align="right">(<a href="#top">back to top</a>)</p>



## Roadmap
WIP

<p align="right">(<a href="#top">back to top</a>)</p>



## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

<p align="right">(<a href="#top">back to top</a>)</p>



## License
This project is published under the terms of **[42 Unlicense](LICENSE)**.

<p align="right">(<a href="#top">back to top</a>)</p>



## Acknowledgement
- [dawnbeen/c_formatter_42](https://github.com/dawnbeen/c_formatter_42)

<p align="right">(<a href="#top">back to top</a>)</p>



## References
### PyPI
```shell
python3 -m twine upload --skip-existing --repository pypi dist/*
python3 -m build
```
- [Packaging Python Projects](https://packaging.python.org/tutorials/packaging-projects/)

### setup.cfg
- [Configuring setup() using setup.cfg files](https://setuptools.pypa.io/en/latest/userguide/declarative_config.html)

### clang-format
- [Clang-Format Style Options](https://clang.llvm.org/docs/ClangFormatStyleOptions.html)

<p align="right">(<a href="#top">back to top</a>)</p>