Setup Readme and CI

Author: AmrDeveloper

.github/FUNDING.yml

@@ -0,0 +1 @@
+github: amrdeveloper

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,29 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**GQL (please complete the following information):**
+ - Version [e.g. 1.0.0]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,19 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/workflows/ci.yaml

@@ -0,0 +1,29 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  fmt:
+    name: Rustfmt
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@stable
+      - run: cargo fmt --all -- --check
+
+  clippy:
+    name: Clippy
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@stable
+      - run: cargo clippy -- -D warnings

.vscode/extensions.json

@@ -0,0 +1,5 @@
+{
+  "recommendations": [
+    "rust-lang.rust-analyzer",
+  ]
+}

CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+## Code of Conduct
+
+### Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+### Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+### Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+### Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+### Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at amr96@programmer.net. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+### Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -0,0 +1,10 @@
+# Contributing
+
+Please provide issue report in the format that we request, EACH DETAIL IS A HUGE HELP.
+
+Issues that are not following the guidelines,
+will be processed as last priority or never or simply closed as invalid.
+
+## Contributing Guide
+
+Please note that PRs are looked only for approved issues.

README.md

@@ -0,0 +1,97 @@
+<h1 align="center">PyQL - A Python Query Language</h1></br>
+
+<p align="center">
+<img src="media/pyql_logo.svg" width="20%" height="20%"/>
+</p>
+
+<p align="center">
+  <img alt="Crates.io" src="https://img.shields.io/crates/v/pyql?style=flat-square">
+  <img alt="Deps" src="https://deps.rs/repo/github/amrdeveloper/pyql/status.svg">
+  <img alt="GitHub issues" src="https://img.shields.io/github/issues/amrdeveloper/pyql">
+  <img alt="GitHub" src="https://img.shields.io/github/license/amrdeveloper/pyql">
+</p>
+
+<p align="center">
+PyQL is a SQL like query language to run on Python source code files instead of database files using the GitQL SDK.
+</p>
+
+<p align="center">
+  <img src="media/pyql_demo.png" alt="animated" width="100%"/>
+</p>
+
+---
+
+### Tables structures
+
+#### Functions table
+
+| Name            | Type       | Description                              |
+| --------------- | ---------- | ---------------------------------------- |
+| function_name   | Text       | The name of Python function              |
+| arguments_count | Integer    | The number of arguments in this function |
+| function        | PyFunction | A pointer to that Function Node in AST   |
+| file_name       | Text       | File name that has this function         |
+
+
+---
+
+### Download or Install
+
+- Install from Cargo.io
+
+```
+cargo install pyql
+```
+
+- Build from source code
+
+```
+git clone https://github.com/AmrDeveloper/PyQL.git
+cd PyQL
+cargo build
+```
+
+### Run PyQL
+
+```
+PyQL is a SQL like query language to run on Python source code files
+Usage: PyQL [OPTIONS]
+
+Options:
+  -f,  --files <paths>        Path for local files to run query on
+  -s,  --script <file>        Script file contains one or more query
+  -q,  --query <GQL Query>    PyQL query to run on selected files
+  -p,  --pagination           Enable print result with pagination
+  -ps, --pagesize             Set pagination page size [default: 10]
+  -o,  --output               Set output format [render, json, csv]
+  -a,  --analysis             Print Query analysis
+  -e,  --editor               Enable GitQL LineEditor
+  -h,  --help                 Print PyQL help
+  -v,  --version              Print PyQL Current Version
+```
+
+### License
+
+```
+MIT License
+
+Copyright (c) 2024 Amr Hesham
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+```

RELEASING.md

@@ -0,0 +1,31 @@
+# Releasing GitQL Application
+
+1. Update the `CHANGELOG.md`:
+2. Update `Cargo.toml` with the new version.
+
+
+3. Commit
+
+   ```
+   $ git commit -am "Prepare version X.Y.X"
+   ```
+
+4. Tag
+
+   ```
+   $ git tag -am "X.Y.Z" X.Y.Z
+   ```
+
+5. Push!
+
+   ```
+   $ git push && git push --tags
+   ```
+
+   This will trigger a GitHub Action workflow which will create a GitHub release and
+   publish to Cargo.
+
+# Releasing PyQL crate
+
+  1. Update `Cargo.toml` with the new version.
+  2. `cargo publish --allow-dirty`