Metadata-Version: 2.1
Name: codeseeker
Version: 0.0.9
Summary: A simple tool to search code in a GitHub repository.
Home-page: https://github.com/leugimkm/codeseeker
Author: leugimkm
Author-email: leugimkm@systrien.com
License: MIT
Platform: UNKNOWN
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE

# CodeSeeker

Search code through a GitHub repo.

![GitHub](https://img.shields.io/github/license/leugimkm/codeseeker)
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.0-4baaaa.svg)](./code_of_conduct.md)
![GitHub languages](https://img.shields.io/github/languages/top/leugimkm/codeseeker)
![GitHub repo size](https://img.shields.io/github/repo-size/leugimkm/codeseeker)
![Github last-commit](https://img.shields.io/github/last-commit/leugimkm/codeseeker)
![maintenance](https://img.shields.io/maintenance/yes/2022)
![GitHub release (latest by date)](https://img.shields.io/github/v/release/leugimkm/codeseeker)
![PyPI - Format](https://img.shields.io/pypi/format/codeseeker)
[![Downloads](https://pepy.tech/badge/codeseeker)](https://pepy.tech/project/codeseeker)

              .                 .          
    ,-. ,-. ,-| ,-. ,-. ,-. ,-. | , ,-. ,-.
    |   | | | | |-' `-. |-' |-' |<  |-' |  
    `-' `-' `-^ `-' `-' `-' `-' ' ` `-' '  

`codeseeker` is simple tool to search for code on GitHub.
By default it searches to the contents of the source code file.

# Installation

`codeseeker` is available on [PyPi](https://pypi.org/project/codeseeker/) (MIT license)
and installation can be performed by running [pip](https://docs.python.org/es/3/installing/index.html)

```
python -m pip install codeseeker
```
To upgrade the package:
```
python -m pip install codeseeker --upgrade
```
To delete the package:
```
python -m pip uninstall codeseeker
```

# Example

To search for a file that contains _"cube"_ in a repository:

    > python -m codeseeker cube
    1 file found.

    repository/path/to/file.py

To open the file in a web browser

    > python -m codeseeker cube -o
    1 file found.

    repository/path/to/file.py

    Opening in a web browser...

To get the file:

    > python -m codeseeker fibonacci --get
    soluciones/serie_fibonacci.py
    sololearn/python_core/code_project_72_Fibonacci.py
    soluciones/menu_ejercicios.py
    soluciones/menu_ejercicios_naive.py
    soluciones/fibonacci.py

    5 file(s) found(s).

    Downloading and creating file(s)...
    Done!

You can also use it like this:

    > codeseeker calendar -r python/cpython
    Lib/test/test_calendar.py
    Lib/calendar.py
    Lib/test/test_strftime.py
    Lib/_strptime.py
    Lib/zoneinfo/_zoneinfo.py
    Tools/scripts/mailerdaemon.py
    Lib/datetime.py
    Lib/email/_parseaddr.py
    Lib/test/test_imaplib.py
    Lib/imaplib.py
    Lib/mailbox.py
    Lib/http/server.py
    Lib/ssl.py
    Lib/http/cookiejar.py
    Lib/test/datetimetester.py

    15 file(s) found(s).

Help command:

    > codeseeker -h

or:

    > codeseeker --help


# Contribution

If you'd like to contribute, fork the repository, commit your changes to main branch 
and send a pull request.
Make sure you add yourself to authors.

