semvec/pypi-packages huggingface dataset:
ultralytics-tools 0.1.1
My short description for my project.
License: MIT
Requires Python: >=3.6.0


📦 setup.py (for humans)
=======================

This repo exists to provide [an example setup.py] file, that can be used
to bootstrap your next Python project. It includes some advanced
patterns and best practices for `setup.py`, as well as some
commented–out nice–to–haves.

For example, this `setup.py` provides a `$ python setup.py upload`
command, which creates a *universal wheel* (and *sdist*) and uploads
your package to [PyPi] using [Twine], without the need for an annoying
`setup.cfg` file. It also creates/uploads a new git tag, automatically.

In short, `setup.py` files can be daunting to approach, when first
starting out — even Guido has been heard saying, "everyone cargo cults
thems". It's true — so, I want this repo to be the best place to
copy–paste from :)

[Check out the example!][an example setup.py]

Installation
-----

```bash
cd your_project

# Download the setup.py file:
#  download with wget
wget https://raw.githubusercontent.com/navdeep-G/setup.py/master/setup.py -O setup.py

#  download with curl
curl -O https://raw.githubusercontent.com/navdeep-G/setup.py/master/setup.py
```

To Do
-----

-   Tests via `$ setup.py test` (if it's concise).

Pull requests are encouraged!

More Resources
--------------

-   [What is setup.py?] on Stack Overflow
-   [Official Python Packaging User Guide](https://packaging.python.org)
-   [The Hitchhiker's Guide to Packaging]
-   [Cookiecutter template for a Python package]



python3 -m pip install --user --upgrade setuptools wheel
python setup.py sdist build
twine upload dist/ultralytics-tools-0.1.0.tar.gz 

License
-------

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or
distribute this software, either in source code form or as a compiled
binary, for any purpose, commercial or non-commercial, and by any means.

  [an example setup.py]: https://github.com/navdeep-G/setup.py/blob/master/setup.py
  [PyPi]: https://docs.python.org/3/distutils/packageindex.html
  [Twine]: https://pypi.python.org/pypi/twine
  [image]: https://farm1.staticflickr.com/628/33173824932_58add34581_k_d.jpg
  [What is setup.py?]: https://stackoverflow.com/questions/1471994/what-is-setup-py
  [The Hitchhiker's Guide to Packaging]: https://the-hitchhikers-guide-to-packaging.readthedocs.io/en/latest/creation.html
  [Cookiecutter template for a Python package]: https://github.com/audreyr/cookiecutter-pypackage
alxcheck 0.1.3
ALX text suite. Shell Utility that checks files for ALX's Project Requirements. Including: General, C, JavaScript and Python projects
License: MIT
Requires Python: >=3.7
Keywords: alx,alx test,test,checks,test suite,green squares

# alxcheck

ALX test Suite. Shell Utility that checks for ALX Project Requirements

## Dependencies

- [`Python3`](https://www.python.org/downloads/)
- [`betty`](https://youtu.be/wDDKOOEPED0?ref=alxcheck)
- [`pycodestyle`](https://pycodestyle.pycqa.org/en/latest/)
- [`semistandard`](https://www.npmjs.com/package/semistandard)

## Features

`alxcheck` checks for the following:

### General

- `README.md` file present.
- `README.md` file is not empty.
- All files in the current folder and sub-folders end with a new line.

### C

- runs `betty` check.
  > Note: You would have to make sure betty is installed. Check out [How To Install Betty](https://youtu.be/wDDKOOEPED0?ref=alxcheck)

### Python

- Python file is executable.
- *shebang* is present and at the top of the file (`#!/usr/bin/python3` or `#!/usr/bin/env python3`)
- Module documentation (docstrings)
- Function documentation (docstrings)
- Class documentation (docstrings)
- Parse and check for syntax error.

### JavaScript

- Javascript file is executable
  > Note: enabled with `-js` or `--nodejs-project` command line switch. See [Usage](#usage) below
- *shebang* is present and at the top of the file (`#!/usr/bin/node` or `#!/usr/bin/env node`)
  > Note: enabled with `-js` or `--nodejs-project` command line switch. See [Usage](#usage) below
- `semistandard` check
  > Note: you would have to install semistandard `npm install semistandard -g`
- `var` is not used.

## Installation

```bash
pip install alxcheck
```

or

```bash
python3 -m pip install alxcheck
```

## Usage

After installation, to use this package, just run it as a shell command. This starts the checks with the current working directory as the root of the project.

```bash
alxcheck
```

If the project is a JavaScript project with node.js scripts, a command line switch can be used to enable the first two checks [listed above](#javascript).

```bash
alxcheck -js #shorthand version
```

or

```bash
alxcheck --nodejs-project #long version
```

## Contributing

Feel free to contribute to the project by opening [issues](https://github.com/Emmo00/alxcheck/issues) or submitting [pull requests](https://github.com/Emmo00/alxcheck/pulls). Your feedback is valuable!

## License

This project is licensed under the [MIT License](./LICENSE).