Code Monkey home page Code Monkey logo

burocrata's Introduction

Fatiando a Terra

Website | Documentation | Gallery | Docs (development version) | Mailing list

Latest version on PyPI Travis CI build status AppVeyor build status Test coverage status Code health report by landscape.io doi:10.5281/zenodo.157746

Disclaimer

Fatiando is under active development and we are still changing the API between releases. Names will change and functions will move as we improve our design. You might have to update your scripts and notebooks to get the latest features from a new release.

Please bear with us.

Overview

Our goal is provide a comprehensive and extensible framework for geophysical data analysis and the development of new methodologies.

Research: Make your research more reproducible by writing a Python script or Jupyter notebook instead of clicking through complicated menus.

Development: Don't start from scratch! Build upon the existing tools in Fatiando to develop new methods.

Teaching: Combine Fatiando with the Jupyter notebook to make rich, interactive documents. Great for teaching fundamental concepts of geophysics!

Getting started

  1. Install Fatiando and its dependencies.
  2. Browse the Gallery for examples of what Fatiando can do.
  3. Take a look at the rest of the Documentation for more information about the library.
  4. Get involved in the community and see how you can help in our Contributor Guide.

Contributing and asking for help

Subscribe to our Google Groups mailing list to stay informed and ask for help: groups.google.com/d/forum/fatiando

We'll post updates to the list about new releases and features, events, and future plans for the project. Get involved to help us shape the project and make it even better!

Another option for reaching out and reporting bugs is to open an issue on Github.

We have an open development process where everything is discussed through Github issues. Anyone can comment and give feedback. See our Roadmap for v1.0 to get a feeling for where the project is headed. Your input is welcome!

Supporting

If you use Fatiando in your research, please cite it in your publications as:

Uieda, L., V. C. Oliveira Jr, and V. C. F. Barbosa (2013), Modeling the Earth with Fatiando a Terra, Proceedings of the 12th Python in Science Conference, pp. 91 - 98.

Please also cite the method papers of individual functions/classes. References are available in the documentation of each module/function/class.

See the CITATION.rst file or the Citing section of the docs for more information.

You can also show your support by buying a sticker from Stickermule. We don't make any money from the sales but it helps spread the word about the project.

License

Fatiando a Terra is free software: you can redistribute it and/or modify it under the terms of the BSD 3-clause License. A copy of this license is provided in LICENSE.txt.

burocrata's People

Contributors

dependabot[bot] avatar leouieda avatar

Stargazers

avatar

Watchers

avatar avatar

Forkers

diogoocruz

burocrata's Issues

Allow to pass a single file as argument to the CLI

Description of the desired feature:

Currently, burocrata expects a directory to be passed as argument to the CLI. It would be nice if we could alternatively pass a single file to it.

We should be checking if the passed argument is a file or a directory and then act accordingly.
If the passed argument is a file, I think we can safely ignore the --extension option.

Maybe we can refactor the main function and move these lines to their own private function that will return the list of missing files. In case the passed argument is a file, then the function should just check if the file lacks the license notice or not:

burocrata/burocrata/cli.py

Lines 84 to 99 in 119839f

missing_notice = []
for directory in directories:
amount = 0
for ext in extensions:
for path in directory.glob(f"**/*.{ext}"):
if gitignore.match_file(path):
continue
amount += 1
source_code = path.read_text().split("\n")
if not source_code:
missing_notice.append(path)
else:
for notice_line, file_line in zip(notice, source_code):
if notice_line != file_line:
missing_notice.append(path)
break

Are you willing to help implement and maintain this feature?

I'll be glad to!

Remove the --extension argument and set this value in pyproject.toml

Description of the desired feature:

From #10, it became clear that we should passing this sort of option on the command line. Having it all in the pyproject.toml file makes it easier to run the tool since no matter what the project wants, it's always just burocrata FILE or burocrata --check FILE.

We should remove the option and create a new section in the pyproject.toml to add extensions. It would be a list of extensions and could be with or without the .. It should default to the same as the current default.

Are you willing to help implement and maintain this feature?

Yes but would love some help if anyone is up for it!

Add some unit tests

Description of the desired feature:

This package was tested on its own code and other Fatiando projects but doesn't currently have any unit tests. It would be nice to have some for the parsing and editing code in burocrata/tests to get started. Testing the CLI is more complicated but if we can have some tests for the inner code it would already be great.

This will require moving the code from main() into separate functions that can be tested.

Are you willing to help implement and maintain this feature?

Maybe but it will take some time so if anyone else wants to try this I'd be more than happy.

Add option to ignore files

Description of the desired feature:

Would be nice if we can include a list of files in the pyproject.toml that we don't want to be checked or modified by burocrata. The syntax could be similar to what isort does with skip, flake8 with exclude, and ruff with exclude.

It would be nice if we can list files and/or globs. For example:

[tool.burocrata]
notice = '''
# Copyright (c) YYYY Name of Developer.
# Distributed under the terms of the BSD 3-Clause License.
# SPDX-License-Identifier: BSD-3-Clause'''
exclude = ["foo/bar.py", "lorem/*.py"]

This idea originated in https://github.com/orgs/fatiando/discussions/139#discussioncomment-8647144

Are you willing to help implement and maintain this feature?

That will be fun!

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.